OrbitSenderDocs
ReferencePromoções

Listar cupons salvos

GET
/api/external/list-coupons

Lista os cupons salvos da conta (até 500), para usar em coupon: { type: saved, id_coupon }. Para app de parceiro, code e link voltam mascarados.

Authorization

x-api-key<token>

Chave de API no formato sk_live_..., no header x-api-key.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/external/list-coupons"
{  "success": true,  "total": 0,  "coupons": [    {      "id_coupon": "string",      "name": "string",      "store": "string",      "coupon_mode": "link",      "code": "string",      "link": "string",      "discount": {        "type": "percentage",        "amount": 0,        "max_amount": 0      },      "valid_until": "string",      "expired": true    }  ]}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Forbidden",  "code": "plan_feature_locked",  "message": "Seu plano permite 1 link por pedido. Para vários links de uma vez é preciso o Multi Sender.",  "feature": "multi_sender"}
{  "success": false,  "error": "Too Many Requests",  "code": "too_many_active_jobs",  "message": "Esta conta já tem 3 pedidos de promoção em andamento. Aguarde um terminar."}
{  "success": false,  "error": "Internal Server Error",  "code": "internal_error",  "message": "Erro interno ao processar o pedido de promoção."}
{  "success": false,  "error": "Service Unavailable",  "code": "service_paused",  "message": "A geração de promoções pela API está pausada no momento. Tente novamente mais tarde."}