Cupons

Listagem de todos os cupons de produtos do produtor

Required scopes:myeduzz_products_read
Rate limit:30 requests/minute
GET
https://api.eduzz.com/myeduzz/v1/products/coupons

Lista todos os cupons de produtos cadastrados na conta do produtor

Query params

page
number

Página atual

itemsPerPage
number

Número de itens por página

Response params (200)

pages
number

Número de páginas

page
number

Página atual

itemsPerPage
number

Número máximo de itens por página

totalItems
number

Número total de items

items
array of object

Cupons de produtos cadastrados na conta do produtor

items[n].code
string

Código do cupom

items[n].description
string

Descrição do cupom

items[n].value
number

Valor do desconto

items[n].type
enum

Tipo de desconto

value
percentage
items[n].quantity
number

Quantidade de cupons disponibilizados

items[n].limitDateNullable
datetime

Data de validade do cupom

items[n].products
array of object

Produtos aos quais o cupom se aplica

items[n].products[n].id
string

Id do produto

items[n].products[n].title
string

Título do produto

items[n].products[n].price
object

Preço do produto

items[n].products[n].price.currency
string

Moeda do preço

items[n].products[n].price.value
number

Valor do produto

items[n].products[n].priceWithDiscount
object

Preço do produto

items[n].products[n].priceWithDiscount.currency
string

Moeda do preço

items[n].products[n].priceWithDiscount.value
number

Valor do produto

items[n].products[n].link
string

Link do produto com o cupom aplicado

Status codes

StatusDescrição
200Success
403Permissão insuficiente
500Erro interno do servidor
Swagger Logo

Exemplos

1curl --request GET \
2	--url 'https://api.eduzz.com/myeduzz/v1/products/coupons' \
3	--header 'Accept: application/json' 
Response
1{
2  "pages": 821,
3  "page": 1,
4  "itemsPerPage": 3,
5  "totalItems": 2461,
6  "items": [
7    {
8      "code": "CUPOM123",
9      "description": "Cupom simples",
10      "value": 10,
11      "type": "value",
12      "quantity": 1000,
13      "limitDate": "2029-03-20T16:24:47.180Z",
14      "products": [
15        {
16          "id": "1234",
17          "title": "Produto Simples 1",
18          "price": {
19            "currency": "BRL",
20            "value": 200
21          },
22          "priceWithDiscount": {
23            "currency": "BRL",
24            "value": 190
25          },
26          "link": "https://linkdevenda/produto?cupom=CUPOM123"
27        }
28      ]
29    },
30    {
31      "code": "CUPOM456",
32      "description": "Cupom complexo",
33      "value": 10,
34      "type": "percentage",
35      "quantity": 1000,
36      "limitDate": "2029-03-20T16:24:47.180Z",
37      "products": [
38        {
39          "id": "1234",
40          "title": "Produto Simples 1",
41          "price": {
42            "currency": "BRL",
43            "value": 200
44          },
45          "priceWithDiscount": {
46            "currency": "BRL",
47            "value": 180
48          },
49          "link": "https://linkdevenda/produto?cupom=CUPOM456"
50        },
51        {
52          "id": "12345",
53          "title": "Produto Simples 2",
54          "price": {
55            "currency": "BRL",
56            "value": 500
57          },
58          "priceWithDiscount": {
59            "currency": "BRL",
60            "value": 450
61          },
62          "link": "https://linkdevenda/produto?cupom=CUPOM456"
63        }
64      ]
65    }
66  ]
67}