Tabela de conteúdos

Documentação para integração API Easy Promo

Documentação para integração API Easy Promo

Cadastrar produto

Método para cadastrar um produto.

Método	URL
POST	http://{dominio}/api/v1/accounts/integrations/products
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer
Corpo da requisição
Campo	Tipo	Descrição
unit	string (pc,kg,mt,cx,jg,pr,cj,un,hr,pt,lt)	Unidade do produto
name	string (3,100)	Nome do produto
category	string (3,100)	Categoria do produto
subcategory	string (3,100)	Subcategoria do produto
barcode	string (1,20)	Código de barras do produto no formato [0-9]
price	number	Preço do produto
active	boolean	Produto está ativo ou inativo

Exemplo:

{
  "unit": "un",
  "name": "Batata Pringles Cheddar Bacon 105g",
  "category": "Biscoitos e chocolates",
  "subcategory": "Salgadinho",
  "barcode": "13456789",
  "price": 12.99,
  "active": true
}

Listar promoções

Método para listar promoções cadastradas.

Método	URL
GET	http://{dominio}/api/v1/accounts/integrations/promotions
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer

[
    {
        "id": 1,
        "product": {
            "id": 1,
            "account_id": 1,
            "unit": "un",
            "name": "Arroz",
            "category": "Arroz",
            "subcategory": "Arroz",
            "barcode": "123456789",
            "active": 1,
            "created_at": "2024-05-20T12:01:22.000000Z",
            "updated_at": "2024-05-21T19:09:30.000000Z"
        },
        "percent_off": 10,
        "limit": 1,
        "quantity_limit": 2,
        "minimum_quantity": 1,
        "starts_at": "2024-05-20T12:06:23.000000Z",
        "expires_at": null,
        "disabled_at": null,
        "active": true,
        "created_at": "2024-05-20T12:06:27.000000Z",
        "updated_at": "2024-05-21T12:24:52.000000Z"
    }
]

Adicionar promoção

Método para adicionar uma promoção.

Método	URL
POST	http://{dominio}/api/v1/accounts/integrations/promotions
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer
Corpo da requisição
Campo	Tipo	Descrição
limit	number	Limite de compras por CPF
barcode	string(1,20)	Código de barras do produto no formato [0-9]
minimum_quantity	number	Quantidade mínima de produtos para ativação do desconto
percent_off	number	Valor da porcentagem do desconto
quantity_limit	number	Quantidade de unidades a serem descontadas
starts_at	string	Data de início da promoção
active	boolean	Campo ativo

{
    "limit": 0,
    "barcode": "1234",
    "minimum_quantity": 0,
    "percent_off": 10,
    "quantity_limit": 0,
    "starts_at": "2024-05-22 15:45:00",
    "active": true
}

Atualizar promoção

Método para atualizar uma promoção.

Método	URL
PUT	http://{dominio}/api/v1/accounts/integrations/promotions/{id}
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer
Corpo da requisição
Campo	Tipo	Descrição
limit	number	Limite de compras por CPF
barcode	string(1,20)	Código de barras do produto no formato [0-9]
minimum_quantity	number	Quantidade mínima de produtos para ativação do desconto
percent_off	number	Valor da porcentagem do desconto
quantity_limit	number	Quantidade de unidades a serem descontadas
starts_at	string	Data de início da promoção
active	boolean	Campo ativo

{
    "limit": 0,
    "barcode": "1234",
    "minimum_quantity": 0,
    "percent_off": 10,
    "quantity_limit": 0,
    "starts_at": "2024-05-22 15:45:00",
    "active": true
}

Excluir promoção

Método para excluir uma promoção cadastrada.

Método	URL
DELETE	http://{dominio}/api/v1/accounts/integrations/promotions/{id}
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer

Adicionar compra

Método para adicionar uma compra.

Método	URL
PUT	http://{dominio}/api/v1/accounts/integrations/shops
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer
Corpo da requisição
Campo	Tipo	Descrição
consumer	string	CPF/CNPJ do consumidor, nulo em caso de venda não identificada
date	string	Data da venda no formato yyyy-mm-dd HH:mm:ss
reference	string	Número de referência da venda, podendo ser qualquer valor gerado pelo ERP
type	string	DAV,OS,FOOD,CF,NF
pdv	string	Número do PDV
coupon	string	Número do cupom
operator	string	Operador de caixa
payments	array	Lista de pagamentos do tipo objeto
payments.method	number	ID da forma de pagamento (1-Dinheiro, 2-Cartão de débito, 3-Cartão de crédito, 4-Cheque, 5-Cartão benefício / Vale refeição, 6-Pix, 7-Carteira digital, 8-Outros, 9-Troco digital)
payments.total	number	Valor total do pagamento
payments.digital_change	number	Valor do troco digital (opcional)
payments.splits	number	Número referente a pagamento parcelado
payments.date	string	Data do pagamento no formato yyyy-mm-dd HH:mm:ss
items	array	Itens da compra
items.unit	string	Unidade do item (pc,kg,mt,cx,jg,pr,cj,un,hr,pt,lt)
items.name	string	Nome do item
items.category	string	Cateogira do item
items.subcategory	string	Subcategoria do item
items.barcode	string	Código de barras do item
items.unit_value	numeric	Valor unitário do item
items.quantity	numeric	Quantidade do item
items.discount	numeric	Desconto do item
items.total	numeric	Valor total do item
items.promotion_id	string	ID da promoção para desconto

{
    "consumer": "53933515009",
    "date": "2024-05-24 15:10",
    "reference": "11",
    "type": "CF",
    "pdv": "1",
    "coupon": "15",
    "operator": "Manu",
    "payments": [
        {
            "method": 1,
            "total":  24,
            "splits": 0,
            "digital_change": 0,
            "date": "2023-12-21 15:32:00"
        }
    ],
    "items": [
        {
            "unit": "un",
            "name": "Batata Pringles Cheddar Bacon 105g",
            "category": "Biscoitos e chocolates",
            "subcategory": "Salgadinho",
            "barcode": "13456789",
            "unit_value": 12,
            "quantity": 2,
            "discount":  0,
            "total": 24
        }
    ]
}

Cancelar compra

Método para cancelar uma compra.

Método	URL
POST	http://{dominio}/api/v1/accounts/integrations/shops/cancel
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer
Corpo da requisição
Campo	Tipo	Descrição
date	string	Data da venda no formato yyyy-mm-dd
pdv	string	Número do PDV
coupon	string	Número do cupom
type	string	Tipo (DAV,OS,FOOD,CF,NF)
reference	string	Referência

{
    "date": "2024-05-22",
    "pdv": "1",
    "coupon": "7",
    "type": "NF"
}

ou

{
    "date": "2024-05-22",
    "type": "NF"
    "reference": "1"
}

Descontos do consumidor

Método para exibir os descontos de um consumidor.

Método	URL
POST	http://{dominio}/api/v1/accounts/integrations/shops/discounts
Parâmetros query string
Campo	Tipo	Descrição
not_show_discounts	1	Não exibir os descontos dos produtos
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer
Corpo da requisição
Campo	Tipo	Descrição
consumer	string	CPF/CNPJ do consumidor
reference	string	Referência
type	string	Tipo
pdv	string	PDV
coupon	string	Número do cupom
date	string	Data no formato (YYYY-MM-DD HH:mm)
items	array	Lista de itens da compra
items.barcode	string	Código de barras do item no formato [0-9]
items.unit_value	number	Valor unitário do item
items.quantity	number	Quantidade do item
items.discount	number	Desconto do item
items.total	number	Total do item
Corpo da resposta
wallet	object	Objeto da carteira do consumidor
wallet.total_points	number	Total de pontos do consumidor
wallet.total_balance	number	Saldo total do vale compras
wallet.total_shoppings	number	Total em compras
wallet.count_shoppings	number	Quantidade de compras
wallet.total_discounts	number	Total de compras
discounts	object	Objeto com os descontos do consumidor
discounts.barcode	string	Código de barras do item
discounts.promotion_id	string	ID da promoção
discounts.price	number	Preço unitário do item
discounts.final_price	number	Preço final unitário do item com desconto
discounts.discount	number	Desconto total a ser aplicado no item da venda

Exemplo envio:

{
    "consumer": "53933515009",
    "date": "2024-06-19",
    "pdv": "1",
    "coupon": "1",
    "reference": "1",
    "type": "DAV"
    "items": [
        {
            "barcode": "999999",
            "unit_value": 36.59,
            "quantity": 3,
            "discount": 0,
            "total": 109.77
        }
    ]
}

Exemplo resposta:

{
    "wallet": {
        "total_points": 52.99,
        "total_balance": 62.16,
        "total_shoppings": 152.99,
        "count_shoppings": 7,
        "digital_change": 0,
        "total_discounts": 15
    },
    "discounts": {
        "999999": {
            "barcode": "999999",
            "promotion_id": 7,
            "price": 36.59,
            "final_price": 32.931000000000004,
            "discount": 7.318
        }
    }
}

Resgate de vale compras

Método para resgatar vale compras do consumidor

Método	URL
POST	http://{dominio}/api/v1/accounts/integrations/consumers/{document}/balance/redeem
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer
Corpo da requisição
Campo	Tipo	Descrição
value	number	Valor a ser resgatado
digital_change	number	Valor a ser resgatado do troco digital
reference	string	Número de referência
coupon	string	Número cupom
pdv	string	Número do PDV
date	string	Data no formato YYYY-MM-DD HH:MM
type	string	Tipo da compra(DAV,OS,FOOD,CF,NF)

{
  "date": "2024-06-19 17:13",
  "value": 10,
  "digital_change": 2,
  "coupon": "2",
  "reference": "2",
  "pdv": "2",
  "type": "NF"
}

Consultar carteira

Método para consultar a carteira do consumidor.

Método	URL
GET	http://{dominio}/api/v1/accounts/integrations/consumers/document/{document}/wallet
Cabeçalho
Campo	Descrição
X-Store-Token	Token da loja
Authorization	Token de autorização do tipo Bearer

Documentação de software

Ferramentas do usuário

Ferramentas do site