Listar cupons
Referência da API
- Introdução
- Autenticação
- Catálogo
- Checkout
- Configurações
- Conteúdo
- Clientes
- Leads
- Logística
- Marketing
- Pedidos
- Sistema
- Promoções
- Filas
- Usuários
- Webhooks
Listar cupons
Retorna uma lista de cupons de desconto de acordo com os filtros especificados
GET
/
{alias}
/
pricing
/
promocodes
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": "<any>",
"free_shipment": true,
"ignore_promotion_products": true,
"start_at": {
"date": "2000-08-17 10:24:24.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"end_at": {
"date": "2000-08-17 10:24:24.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"created_at": {
"date": "2000-08-17 10:24:24.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"updated_at": {
"date": "2000-08-17 10:24:24.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
}
}
]
}
Path Parameters
Alias da loja
Query Parameters
Incluir relacionamentos adicionais
Response
200
application/json
Lista de cupons retornada com sucesso
The response is of type object
.
Was this page helpful?
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": "<any>",
"free_shipment": true,
"ignore_promotion_products": true,
"start_at": {
"date": "2000-08-17 10:24:24.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"end_at": {
"date": "2000-08-17 10:24:24.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"created_at": {
"date": "2000-08-17 10:24:24.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"updated_at": {
"date": "2000-08-17 10:24:24.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
}
}
]
}