Documentação de software

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.
====== Documentação para integração API Easy Promo ======

===== Cadastrar produto =====

Método para cadastrar um produto.

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

</table>
</html>

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.

<html>
<table>
<tbody>
<tr>
    <td>Método</td>
    <td colspan="2">URL</td>
</tr>
<tr>
    <td>GET</td>
    <td colspan="2">http://{dominio}/api/v1/accounts/integrations/promotions</td>
</tr>
<tr>
    <td colspan="3">Cabeçalho</td>
</tr>
<tr>
    <td>Campo</td>
    <td colspan="2">Descrição</td>
</tr>
<tr>
    <td>X-Store-Token</td>
    <td colspan="2">Token da loja</td>
</tr>
<tr>
    <td>Authorization</td>
    <td colspan="2">Token de autorização do tipo Bearer</td>
</tr>
</tbody>
</table>
</html>

  [
      {
          "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.

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

  {
      "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.

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

  {
      "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.

<html>
<table>
<tbody>
<tr>
    <td>Método</td>
    <td colspan="2">URL</td>
</tr>
<tr>
    <td>DELETE</td>
    <td colspan="2">http://{dominio}/api/v1/accounts/integrations/promotions/{id}</td>
</tr>
<tr>
    <td colspan="3">Cabeçalho</td>
</tr>
<tr>
    <td>Campo</td>
    <td colspan="2">Descrição</td>
</tr>
<tr>
    <td>X-Store-Token</td>
    <td colspan="2">Token da loja</td>
</tr>
<tr>
    <td>Authorization</td>
    <td colspan="2">Token de autorização do tipo Bearer</td>
</tr>
</tbody>
</table>
</html>

===== Adicionar compra =====

Método para adicionar uma compra.

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

</tbody>
</table>
</html>

  {
      "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.

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

  {
      "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.

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

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

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

</table>
</html>

  {
    "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.

<html>
<table>
<tbody>
<tr>
    <td>Método</td>
    <td colspan="2">URL</td>
</tr>
<tr>
    <td>GET</td>
    <td colspan="2">http://{dominio}/api/v1/accounts/integrations/consumers/document/{document}/wallet</td>
</tr>
<tr>
    <td colspan="3">Cabeçalho</td>
</tr>
<tr>
    <td>Campo</td>
    <td colspan="2">Descrição</td>
</tr>
<tr>
    <td>X-Store-Token</td>
    <td colspan="2">Token da loja</td>
</tr>
<tr>
    <td>Authorization</td>
    <td colspan="2">Token de autorização do tipo Bearer</td>
</tr>

</table>
</html>
Documentação de software

Ferramentas do usuário

Ferramentas do site

Ferramentas da página
