Saltar al contenido
Guías
EN
Referencia de API
establepromotion:read

Listar cupones

GET/v1/coupons

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<>
type?string

Valor en

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

Valor en

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

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"
{  "data": [    {      "id": "string",      "storeId": "string",      "sellerId": null,      "name": "string",      "status": "draft",      "type": "percentage",      "target": "order",      "amount": 0.1,      "allocation": "once",      "maxQuantity": null,      "applyAfterTaxes": true,      "isAutomatic": true,      "validFrom": null,      "validTo": null,      "usageLimit": null,      "usageCount": 0,      "codeCount": 0,      "ruleCount": 0,      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}