Créer un code d'offre avec l'API Gumroad

Crée un code de réduction que les acheteurs saisissent au paiement. La réduction est en centimes de la devise du produit, sauf si offer_type vaut percent. Le montant et universal ne peuvent plus être modifiés ensuite.

Identifiant
gumroad_create_offer_code

L'appel

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
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
product_idstringOuiId of the product, from List products.
namestringOuiThe code the buyer types at checkout, such as BLACKFRIDAY30.
amount_offintegerOuiDiscount: cents of the product currency, or a percentage when offer_type is percent.
offer_typestringNoncents by default.Valeurs : cents, percent
universalbooleanNontrue makes the code valid for every product of the account. false by default.
max_purchase_countintegerNonHow many times the code can be used.
minimum_amount_centsintegerNonMinimum order total, in cents, for the code to apply.
valid_atstringNonStart of validity, RFC 3339 with time zone, such as 2026-11-27T00:00:00-03:00.
expires_atstringNonEnd of validity, in the same format. It needs valid_at and must come after it.
auto_applybooleanNontrue applies the discount by itself on product pages, as a sale. Only for a universal code, and only one per account.
sale_labelstringNonPlain text label of the automatic sale, up to 32 characters. Sale when empty.

Connexions possibles

Votre client connecte son compte Gumroad une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/gumroad, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/gumroad_create_offer_code. Il devient la définition de tool de votre agent sans conversion.

Autres tools Gumroad

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.