Saltar al contenido
docs
EN
PromocionesCupones

Listar cupones

Devuelve cupones paginados por cursor, filtrables por estado, tipo y destino.

GET/v1/coupons
Requiere un token de acceso con el permiso promotion:read.

Parámetros de consulta

limit?integer

Cantidad máxima de resultados por devolver.

Formatoint32
cursor?string

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

search?string

Búsqueda de texto libre.

sortBy?string

Campo por el que se ordena.

sortDirection?string

Dirección del ordenamiento: asc o desc.

Valor en

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

Solo elementos en estos estados.

Valor en

  • "draft"
  • "active"
  • "scheduled"
  • "inactive"
  • "expired"
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://api.ecomiq.pe/api/v1/coupons" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004329139",      "storeId": "7204558912004327977",      "sellerId": "7204558912004323447",      "name": "Bienvenida 10 %",      "status": "draft",      "type": "percentage",      "target": "order",      "amount": 178,      "allocation": "once",      "maxQuantity": 2,      "applyAfterTaxes": false,      "isAutomatic": false,      "validFrom": "2026-09-28T15:30:00Z",      "validTo": "2026-09-28T15:30:00Z",      "usageLimit": 1,      "usageCount": 24,      "codeCount": 24,      "ruleCount": 24,      "customerUsageLimit": 1,      "combineWithOtherDiscounts": false,      "primaryCode": "POL-001",      "rules": [        {          "field": "cartSubtotal",          "operator": "eq",          "decimalValues": [            1          ],          "integerValues": [            1          ],          "resourceIds": [            "7204558912004324902"          ],          "codes": [            "BIENVENIDA10"          ]        }      ],      "createdOn": "2026-09-28T15:30:00Z",      "updatedOn": "2026-09-28T15:30:00Z"    }  ],  "hasNextPage": true,  "nextCursor": "eyJpZCI6IjcyMDQ1NTg5MTIwMDQzMjUzMDEifQ",  "totalCount": 24}