Aqui você vê as diferenças entre duas revisões dessa página.
integracao_easypromo [2024/06/20 17:25] rafael [Resgate de vale compras] |
integracao_easypromo [2024/11/06 18:06] (atual) rafael |
||
---|---|---|---|
Linha 1: | Linha 1: | ||
====== Documentação para integração API Easy Promo ====== | ====== 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> | <html> | ||
Linha 92: | Linha 92: | ||
| | ||
===== Listar promoções ===== | ===== Listar promoções ===== | ||
+ | |||
+ | Método para listar promoções cadastradas. | ||
<html> | <html> | ||
Linha 151: | Linha 153: | ||
] | ] | ||
- | ===== Adicinonar promoção ===== | + | ===== Adicionar promoção ===== |
- | Método para adicionar promoção | + | Método para adicionar uma promoção. |
<html> | <html> | ||
Linha 238: | Linha 240: | ||
} | } | ||
| | ||
- | ===== Atualiza uma promoção ===== | + | ===== Atualizar promoção ===== |
- | Método para atualizar uma promoção | + | Método para atualizar uma promoção. |
<html> | <html> | ||
Linha 325: | Linha 327: | ||
} | } | ||
| | ||
- | ===== Exclui uma promoção ===== | + | ===== Excluir promoção ===== |
- | Método para excluir uma promoção | + | Método para excluir uma promoção cadastrada. |
<html> | <html> | ||
Linha 359: | Linha 361: | ||
</html> | </html> | ||
- | ===== Adiciona uma compra ===== | + | ===== Adicionar compra ===== |
- | Método para adicionar uma compra | + | Método para adicionar uma compra. |
<html> | <html> | ||
Linha 440: | Linha 442: | ||
<td>payments.method</td> | <td>payments.method</td> | ||
<td>number</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> | ||
<tr> | <tr> | ||
Linha 446: | Linha 448: | ||
<td>number</td> | <td>number</td> | ||
<td>Valor total do pagamento</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> | ||
<tr> | <tr> | ||
Linha 530: | Linha 537: | ||
"total": 24, | "total": 24, | ||
"splits": 0, | "splits": 0, | ||
+ | "digital_change": 0, | ||
"date": "2023-12-21 15:32:00" | "date": "2023-12-21 15:32:00" | ||
} | } | ||
Linha 551: | Linha 559: | ||
===== Cancelar compra ===== | ===== Cancelar compra ===== | ||
- | Método para cancelar uma compra | + | Método para cancelar uma compra. |
<html> | <html> | ||
Linha 633: | Linha 641: | ||
===== Descontos do consumidor ===== | ===== Descontos do consumidor ===== | ||
- | Método para exibir os descontos de um consumidor | + | Método para exibir os descontos de um consumidor. |
<html> | <html> | ||
Linha 645: | Linha 653: | ||
<td>POST</td> | <td>POST</td> | ||
<td colspan="2">http://{dominio}/api/v1/accounts/integrations/shops/discounts</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> | ||
<tr> | <tr> | ||
Linha 824: | Linha 845: | ||
"total_shoppings": 152.99, | "total_shoppings": 152.99, | ||
"count_shoppings": 7, | "count_shoppings": 7, | ||
+ | "digital_change": 0, | ||
"total_discounts": 15 | "total_discounts": 15 | ||
}, | }, | ||
Linha 879: | Linha 901: | ||
<td>number</td> | <td>number</td> | ||
<td>Valor a ser resgatado</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> | ||
<tr> | <tr> | ||
Linha 912: | Linha 939: | ||
"date": "2024-06-19 17:13", | "date": "2024-06-19 17:13", | ||
"value": 10, | "value": 10, | ||
+ | "digital_change": 2, | ||
"coupon": "2", | "coupon": "2", | ||
"reference": "2", | "reference": "2", | ||
Linha 917: | Linha 945: | ||
"type": "NF" | "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> |