Crear código de oferta en Gumroad, con una API
Crea un código de descuento que los compradores escriben en el checkout. El descuento es en centavos de la moneda del producto, salvo que offer_type sea percent. El importe y universal no se pueden cambiar después.
- Identificador
- gumroad_create_offer_code
La llamada
POST https://connect.reportei.com/api/tools/gumroad_create_offer_code/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"product_id": "<product_id>",
"name": "<name>",
"amount_off": 1
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| product_id | string | Sí | Id of the product, from List products. |
| name | string | Sí | The code the buyer types at checkout, such as BLACKFRIDAY30. |
| amount_off | integer | Sí | Discount: cents of the product currency, or a percentage when offer_type is percent. |
| offer_type | string | No | cents by default.Valores: cents, percent |
| universal | boolean | No | true makes the code valid for every product of the account. false by default. |
| max_purchase_count | integer | No | How many times the code can be used. |
| minimum_amount_cents | integer | No | Minimum order total, in cents, for the code to apply. |
| valid_at | string | No | Start of validity, RFC 3339 with time zone, such as 2026-11-27T00:00:00-03:00. |
| expires_at | string | No | End of validity, in the same format. It needs valid_at and must come after it. |
| auto_apply | boolean | No | true applies the discount by itself on product pages, as a sale. Only for a universal code, and only one per account. |
| sale_label | string | No | Plain text label of the automatic sale, up to 32 characters. Sale when empty. |
Conexiones posibles
Tu cliente conecta su cuenta de Gumroad una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/gumroad, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/gumroad_create_offer_code. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Gumroad
- Listar productosGETLista los productos de la cuenta, del más nuevo al más antiguo, 10 por página, en forma resumida: Obtener producto devuelve el producto completo. Cuando hay más, la respuesta trae next_page_key, que va en page_key.
- Obtener productoGETDevuelve un producto con precio, descripción, categoría, etiquetas, variantes, archivos y, con el scope view_sales, sales_count y sales_usd_cents.
- Listar categoríasGETLista las categorías de producto de Gumroad. El path de una categoría, como design/ui-and-web/figma, va en category en Crear producto y Actualizar producto.
- Crear productoPOSTCrea un producto y lo publica de inmediato, salvo que draft sea true. Cuando la publicación está bloqueada, por ejemplo por un email sin confirmar o por falta de método de cobro, el producto queda como borrador y la respuesta trae un warning: publícalo después con Publicar producto.
- Actualizar productoPUTModifica un producto y lo devuelve. Solo cambian los campos enviados, pero tags reemplaza la lista completa. Un warning en la respuesta indica códigos de oferta que dejaron de ser válidos para el producto.
- Publicar productoPUTPublica un borrador o un producto despublicado, para que los compradores puedan comprarlo. Se rechaza mientras la cuenta no tenga email confirmado o método de cobro, o cuando un código de oferta del producto deja el precio inválido.
- Despublicar productoPUTDespublica un producto, lo que detiene nuevas ventas. Publicar producto lo vuelve a poner a la venta.
- Listar ventasGETLista las ventas exitosas de la cuenta, de las más nuevas a las más antiguas, 10 por página, con email del comprador, producto, precio, reembolso y datos de suscripción y licencia. Cuando hay más, la respuesta trae next_page_key, que va en page_key.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
