Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- integracao_easypromo [2024/06/20 17:24]
rafael [Descontos do consumidor]
+++ integracao_easypromo [2025/06/30 12:51] (atual)
rafael [Cadastrar produto]
@@ Linha 1: / Linha 1: @@
 ====== Documentação para integração API Easy Promo ======
-===== Cadastro de produtos =====
+===== Cadastrar produto =====
-Método para cadastro de produtos.
+Método para cadastrar um produto.
 <html>
@@ Linha 73: / Linha 73: @@
     <td>boolean</td>
     <td>Produto está ativo ou inativo</td>
+</tr>
+<tr>
+    <td>image</td>
+    <td>string</td>
+    <td>Base64 da imagem do produto (opcional)</td>
 </tr>
 </tbody>
@@ Linha 88: / Linha 93: @@
     "barcode": "13456789",
     "price": 12.99,
-    "active": true
+    "active": true,
+    "image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAUFBQU..."
   }
 ===== Listar promoções =====
+Método para listar promoções cadastradas.
 <html>
@@ Linha 151: / Linha 159: @@
   ]
-===== Adicinonar promoção =====
+===== Adicionar promoção =====
-Método para adicionar promoção
+Método para adicionar uma promoção.
 <html>
@@ Linha 238: / Linha 246: @@
   }
-===== Atualiza uma  promoção =====
+===== Atualizar promoção =====
-Método para atualizar uma promoção
+Método para atualizar uma promoção.
 <html>
@@ Linha 325: / Linha 333: @@
   }
-===== Exclui uma  promoção =====
+===== Excluir promoção =====
-Método para excluir uma promoção
+Método para excluir uma promoção cadastrada.
 <html>
@@ Linha 359: / Linha 367: @@
 </html>
-===== Adiciona uma compra =====
+===== Adicionar compra =====
-Método para adicionar uma compra
+Método para adicionar uma compra.
 <html>
@@ Linha 440: / Linha 448: @@
     <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)</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>
@@ Linha 446: / Linha 454: @@
     <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>
@@ Linha 530: / Linha 543: @@
               "total":  24,
               "splits": 0,
+              "digital_change": 0,
               "date": "2023-12-21 15:32:00"
           }
@@ Linha 551: / Linha 565: @@
 ===== Cancelar compra =====
-Método para cancelar uma compra
+Método para cancelar uma compra.
 <html>
@@ Linha 633: / Linha 647: @@
 ===== Descontos do consumidor =====
-Método para exibir os descontos de um consumidor
+Método para exibir os descontos de um consumidor.
 <html>
@@ Linha 645: / Linha 659: @@
     <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>
@@ Linha 824: / Linha 851: @@
           "total_shoppings": 152.99,
           "count_shoppings": 7,
+          "digital_change": 0,
           "total_discounts": 15
       },
@@ Linha 879: / Linha 907: @@
     <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>
@@ Linha 884: / Linha 917: @@
     <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>
@@ Linha 895: / Linha 943: @@
   {
-      "value": 30,
+    "date": "2024-06-19 17:13",
-      "reference": "10",
+    "value": 10,
-      "type": "NF"
+    "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

Diferenças

Ferramentas da página