Pular para o conteúdo principal
GET
/
api
/
partner
/
v1
/
merchant
/
coupons
Listar cupons
curl --request GET \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons \
  --header 'X-API-KEY: <api-key>'
{
  "coupons": [
    {
      "name": "<string>",
      "type": "percent_discount",
      "value": 123,
      "id": 123,
      "uid": "<string>",
      "code": null,
      "active": true,
      "minimum_order_value": null,
      "use_limit": null,
      "new_customers_only": false,
      "customer_multi_use": false,
      "availability_start_time": null,
      "availability_end_time": null,
      "available_days": [],
      "available_order_types": [],
      "available_from": null,
      "expires_at": null,
      "item_ids": [
        {
          "id": 123,
          "name": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_coupons": 123
  }
}

Autorizações

X-API-KEY
string
header
obrigatório

Token específico do estabelecimento integrado. Disponível na seção de integrações do Portal do estabelecimento.

Parâmetros de consulta

page
number
padrão:1

Página desejada

Intervalo obrigatório: x >= 1
per_page
number
padrão:20

Quantidade de cupons por página

Intervalo obrigatório: 1 <= x <= 20

Resposta

Retorna um array com os cupons do estabelecimento.

Esse endpoint possui paginação, onde os parâmetros page e per page controlam a paginação, com um limite máximo de 20 cupons por página.

coupons
Cupom · object[]
obrigatório
pagination
object
obrigatório

Informações sobre a paginação

Última modificação em 27 de junho de 2026