Criar código de oferta no Gumroad, por uma API
Cria um código de desconto que os compradores digitam no checkout. O desconto é em centavos da moeda do produto, a menos que offer_type seja percent. O valor e universal não podem ser alterados depois.
- Identificador
- gumroad_create_offer_code
A chamada
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
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| product_id | string | Sim | Id of the product, from List products. |
| name | string | Sim | The code the buyer types at checkout, such as BLACKFRIDAY30. |
| amount_off | integer | Sim | Discount: cents of the product currency, or a percentage when offer_type is percent. |
| offer_type | string | Não | cents by default.Valores: cents, percent |
| universal | boolean | Não | true makes the code valid for every product of the account. false by default. |
| max_purchase_count | integer | Não | How many times the code can be used. |
| minimum_amount_cents | integer | Não | Minimum order total, in cents, for the code to apply. |
| valid_at | string | Não | Start of validity, RFC 3339 with time zone, such as 2026-11-27T00:00:00-03:00. |
| expires_at | string | Não | End of validity, in the same format. It needs valid_at and must come after it. |
| auto_apply | boolean | Não | 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 | Não | Plain text label of the automatic sale, up to 32 characters. Sale when empty. |
Conexões possíveis
O seu cliente conecta a conta do Gumroad uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/gumroad, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/gumroad_create_offer_code. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Gumroad
- Listar produtosGETLista os produtos da conta, do mais novo ao mais antigo, 10 por página, em formato resumido: Obter produto retorna o produto completo. Quando há mais, a resposta traz next_page_key, que vai em page_key.
- Obter produtoGETRetorna um produto com preço, descrição, categoria, tags, variantes, arquivos e, com o escopo view_sales, sales_count e sales_usd_cents.
- Listar categoriasGETLista as categorias de produto do Gumroad. O path de uma categoria, como design/ui-and-web/figma, vai em category em Criar produto e Atualizar produto.
- Criar produtoPOSTCria um produto e o publica na hora, a menos que draft seja true. Quando a publicação é bloqueada, por exemplo por e-mail não confirmado ou falta de forma de recebimento, o produto fica como rascunho e a resposta traz um warning: publique depois com Publicar produto.
- Atualizar produtoPUTAltera um produto e o retorna. Só os campos enviados mudam, mas tags substitui a lista inteira. Um warning na resposta indica códigos de oferta que deixaram de ser válidos para o produto.
- Publicar produtoPUTPublica um rascunho ou produto despublicado, para que compradores possam comprá-lo. Recusado enquanto a conta não tiver e-mail confirmado ou forma de recebimento, ou quando um código de oferta do produto deixa o preço inválido.
- Despublicar produtoPUTDespublica um produto, o que interrompe novas vendas. Publicar produto o coloca de volta à venda.
- Listar vendasGETLista as vendas concluídas da conta, das mais novas às mais antigas, 10 por página, com e-mail do comprador, produto, preço, reembolso e dados de assinatura e licença. Quando há mais, a resposta traz next_page_key, que vai em page_key.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
