Skip to main content
GET
/
{alias}
/
pricing
/
promocodes
Listar cupons
curl --request GET \
  --url https://api.dooki.com.br/v2/{alias}/pricing/promocodes \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>'
{
  "data": [
    {
      "id": 123,
      "code": "TEST",
      "description": "",
      "customer_id": 123,
      "active": true,
      "expired": true,
      "discount_type": "p",
      "for_the_price_of": true,
      "cart_default": true,
      "type_increment_value": "",
      "value": 10,
      "price_products": 123,
      "percent_products": 123,
      "quantity": "100000",
      "total_customers_used": "22",
      "product_quantity": 123,
      "product_max_quantity": 123,
      "used": 22,
      "items_count": 123,
      "min_value": 99.99,
      "use_percent": 0.02,
      "shipment_percent": 123,
      "accumulate": true,
      "once_per_customer": true,
      "abandoned_cart": true,
      "newsletter": true,
      "payments_ids": "<unknown>",
      "free_shipment": true,
      "ignore_promotion_products": true,
      "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"
      }
    }
  ]
}
Esta API possui limites de requisições (rate limits) para garantir estabilidade. Cada endpoint tem um limite específico de chamadas por minuto. Este endpoint em específico tem um limite de requisições por minuto.

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Query Parameters

include
enum<string>[]

Incluir relacionamentos adicionais

Available options:
customer,
categories,
collections,
brand,
products,
payments
filters
Filtros de cupons · object

Filtros de Cupons Objeto que mapeia os filtros disponíveis para pesquisa de cupons.

Response

Lista de cupons retornada com sucesso

data
Código Promocional · object[]