Listar cupons

GET

Markdown (LLM)

Retorna os cupons da empresa.

Escopo:coupons:read

Limite:100 requisições a cada 3 minutos.

Parâmetros de query

pageinteger

Página atual da lista.

1

limitinteger

Quantidade de itens por página.

20

sortstring

Ordem da lista: mais recentes (desc) ou mais antigos (asc).

Enum

ascCrescente
descDecrescente (padrão)

"desc"

merchantIdinteger

Filtra por cardápio.

1

codestring

Filtra pelo código digitado pelo cliente.

"PIX15%"

activeboolean

Filtra por cupons ativos ou inativos. Ausente = todos.

true

typestring

Filtra pelo tipo do benefício: percentagefixed

"percentage"

appliesTostring

Filtra pelo alvo do benefício: discountdeliveryFeeproduct

"discount"

validFromstring (ISO 8601)

Filtra pelos cupons vigentes a partir dessa data.

"2026-03-01T00:00:00-03:00"

validUntilstring (ISO 8601)

Filtra pelos cupons vigentes até essa data.

"2026-03-31T23:59:59-03:00"

paymentMethodTypestring

Filtra pelos cupons restritos a uma forma de pagamento listada em advanced.paymentMethods.

"PIX_BEEFOOD"

applicationModestring

Filtra pelo modo de aplicação: orderunlockByItemsitemsOnly

"order"

Parâmetros da resposta

couponIdnumber

ID do cupom.

15237

codestring

Código para a utilização do cupom.

"PIX15%"

pagenumber

Página atual da lista.

1

limitnumber

Quantidade de itens por página.

2

totalnumber

Total de registros encontrados.

13

pagesnumber

Total de páginas.

7

Linguagem

Produção

Requisição

GET /v1/store/coupons

12345678import axios from "axios";
const { data } = await axios({
  method: "get",
  url: "https://api.beefood.app/v1/store/coupons?page=1&limit=20&sort=desc",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});

Resposta

json

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124{
  "items": [
    {
      "couponId": 15237,
      "storeId": 38311,
      "merchantId": 39202,
      "code": "PIX15%",
      "active": true,
      "usageCount": 0,
      "benefit": {
        "appliesTo": "discount",
        "type": "percentage",
        "amount": 15
      },
      "validity": {
        "startsAt": "2026-08-22T23:34:00.000-03:00",
        "weekdays": {
          "monday": true,
          "tuesday": true,
          "wednesday": true,
          "thursday": true,
          "friday": true,
          "saturday": true,
          "sunday": true
        }
      },
      "channels": {
        "delivery": true,
        "pdv": true,
        "tables": true,
        "totem": true
      },
      "rules": {
        "minimumOrderAmount": 0,
        "limitOnePerCustomer": false,
        "hasQuantityLimit": false,
        "maxQuantity": 0,
        "firstPurchaseOnly": false,
        "showOnMenu": true,
        "pickupOrLocalOnly": false,
        "excludePromotionalProducts": false,
        "requirePhoneSms": true
      },
      "advanced": {
        "paymentMethods": [
          {
            "paymentMethodId": 486229,
            "name": "PIX Bee",
            "type": "PIX_BEEFOOD"
          },
          {
            "paymentMethodId": 381233,
            "name": "PIX Online",
            "type": "PIX_BEEFOOD"
          }
        ],
        "application": {
          "mode": "order",
          "sectors": [],
          "products": []
        }
      }
    },
    {
      "couponId": 15233,
      "storeId": 38311,
      "merchantId": 39202,
      "code": "10%SETIVERBOX",
      "active": true,
      "usageCount": 0,
      "benefit": {
        "appliesTo": "discount",
        "type": "percentage",
        "amount": 10
      },
      "validity": {
        "startsAt": "2026-08-23T13:14:00.000-03:00",
        "weekdays": {
          "monday": true,
          "tuesday": true,
          "wednesday": true,
          "thursday": true,
          "friday": true,
          "saturday": true,
          "sunday": true
        }
      },
      "channels": {
        "delivery": true,
        "pdv": true,
        "tables": true,
        "totem": true
      },
      "rules": {
        "minimumOrderAmount": 0,
        "limitOnePerCustomer": false,
        "hasQuantityLimit": false,
        "maxQuantity": 0,
        "firstPurchaseOnly": false,
        "showOnMenu": true,
        "pickupOrLocalOnly": false,
        "excludePromotionalProducts": false,
        "requirePhoneSms": false
      },
      "advanced": {
        "paymentMethods": [],
        "application": {
          "mode": "unlockByItems",
          "sectors": [],
          "products": [
            {
              "productId": 2515304,
              "name": "(Box) Batata frita"
            }
          ]
        }
      }
    }
  ],
  "page": 1,
  "limit": 2,
  "total": 13,
  "pages": 7
}