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âmetroTipoObrigatórioDescrição
product_idstringSimId of the product, from List products.
namestringSimThe code the buyer types at checkout, such as BLACKFRIDAY30.
amount_offintegerSimDiscount: cents of the product currency, or a percentage when offer_type is percent.
offer_typestringNãocents by default.Valores: cents, percent
universalbooleanNãotrue makes the code valid for every product of the account. false by default.
max_purchase_countintegerNãoHow many times the code can be used.
minimum_amount_centsintegerNãoMinimum order total, in cents, for the code to apply.
valid_atstringNãoStart of validity, RFC 3339 with time zone, such as 2026-11-27T00:00:00-03:00.
expires_atstringNãoEnd of validity, in the same format. It needs valid_at and must come after it.
auto_applybooleanNãotrue applies the discount by itself on product pages, as a sale. Only for a universal code, and only one per account.
sale_labelstringNãoPlain 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

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.