Sign in

v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Promoções - Cupons de desconto

Listar cupons

Retorna uma lista de cupons de desconto de acordo com os filtros especificados

get/{alias}/pricing/promocodes

Path parameters

aliasstring required

Alias da loja

Query parameters

includestring[]

Incluir relacionamentos adicionais

[
  "?include=customer,products"
]
statusboolean

Define se o cupom está ativo ou inativo.

expiredboolean

Filtra cupons expirados (compara end_at com a data atual).

qstring

Busca por prefixo do código do cupom.

rulesstring[]

Regras booleanas (ex.: rules[]=accumulate&rules[]=newsletter).

Filtros de Cupons

{
  "q": "?q=FRETE10"
}

Response

Lista de cupons retornada com sucesso

Example response

{
  "data": [
    {
      "code": "TEST",
      "value": 10,
      "used": 22,
      "min_value": 99.99,
      "use_percent": 0.02,
      "payments_ids": "[1, 2, 3, 4]",
      "start_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "end_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "created_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "updated_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      }
    }
  ]
}