Saltar al contenido
docs
Guías
EN
PromocionesCupones
promotion:read

Listar cupones

GET/v1/coupons

Listar cupones. Una solicitud exitosa devuelve HTTP 200 con el cuerpo de respuesta documentado.

Autorización

bearerAuth
AutorizaciónBearer <token>

Token de acceso OAuth 2.0 emitido por Ecomiq Auth.

Ubicación: header

Parámetros de consulta

limit?integer

Cantidad máxima de resultados por devolver.

Formatoint32
cursor?string

Cursor opaco de la respuesta anterior. Omítelo en la primera página.

search?string

Filtro de texto libre. Los campos consultados dependen del recurso.

sortBy?string

Campo de ordenamiento. Los valores admitidos dependen del recurso.

sortDirection?string

Dirección del ordenamiento: asc o desc.

Valor en

  • "asc"
  • "desc"
status?array<>

Solo elementos en estos estados.

type?string

Solo este tipo.

Valor en

  • "percentage"
  • "fixedAmount"
  • "freeShipping"
  • "buyXGetY"
target?string

Valor en

  • "order"
  • "item"
  • "shipping"

Parámetros de cabecera

x-Store-Id?string

Tienda sobre la que actúa la solicitud. No hace falta cuando el token ya está vinculado a una tienda.

Authorization*string

Token bearer OAuth 2.0.

Cuerpo de la respuesta

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/coupons" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "storeId": "7204558912004325301",      "sellerId": "7204558912004325301",      "name": "Example resource",      "status": "draft",      "type": "percentage",      "target": "order",      "amount": 1,      "allocation": "once",      "maxQuantity": 1,      "applyAfterTaxes": false,      "isAutomatic": false,      "validFrom": "2026-08-01T15:30:00Z",      "validTo": "2026-08-01T15:30:00Z",      "usageLimit": 1,      "usageCount": 1,      "codeCount": 1,      "ruleCount": 1,      "createdOn": "2026-08-01T15:30:00Z",      "updatedOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}