Ferramentas do usuário
integracao_easypromo
Diferenças
Aqui você vê as diferenças entre duas revisões dessa página.
|
integracao_easypromo [2024/06/20 17:20] rafael [Cancelar compra] |
integracao_easypromo [2025/08/27 20:14] (atual) rafael [Descontos do consumidor] |
||
|---|---|---|---|
| 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 73: | Linha 73: | ||
| <td>boolean</td> | <td>boolean</td> | ||
| <td>Produto está ativo ou inativo</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> | </tr> | ||
| </tbody> | </tbody> | ||
| Linha 88: | Linha 93: | ||
| "barcode": "13456789", | "barcode": "13456789", | ||
| "price": 12.99, | "price": 12.99, | ||
| - | "active": true | + | "active": true, |
| + | "image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAUFBQU..." | ||
| } | } | ||
| | | ||
| ===== Listar promoções ===== | ===== Listar promoções ===== | ||
| + | |||
| + | Método para listar promoções cadastradas. | ||
| <html> | <html> | ||
| Linha 145: | Linha 153: | ||
| "expires_at": null, | "expires_at": null, | ||
| "disabled_at": null, | "disabled_at": null, | ||
| + | "flash_offer_enabled": false, | ||
| "active": true, | "active": true, | ||
| "created_at": "2024-05-20T12:06:27.000000Z", | "created_at": "2024-05-20T12:06:27.000000Z", | ||
| Linha 151: | Linha 160: | ||
| ] | ] | ||
| - | ===== Adicinonar promoção ===== | + | ===== Adicionar promoção ===== |
| - | Método para adicionar promoção | + | Método para adicionar uma promoção. |
| <html> | <html> | ||
| Linha 218: | Linha 227: | ||
| <td>string</td> | <td>string</td> | ||
| <td>Data de início da promoção</td> | <td>Data de início da promoção</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>expires_at</td> | ||
| + | <td>string</td> | ||
| + | <td>Data de término da promoção</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>flash_offer_enabled</td> | ||
| + | <td>boolean</td> | ||
| + | <td>Oferta relâmpago ativa (Campo expires_at é obrigatório)</td> | ||
| </tr> | </tr> | ||
| <tr> | <tr> | ||
| Linha 234: | Linha 253: | ||
| "percent_off": 10, | "percent_off": 10, | ||
| "quantity_limit": 0, | "quantity_limit": 0, | ||
| - | "starts_at": "2024-05-22 15:45:00", | + | "starts_at": "2024-05-22 15:45:00 |
| + | "expires_at": "2024-05-23 15:45:00", | ||
| + | "flash_offer_enabled": true, | ||
| "active": true | "active": true | ||
| } | } | ||
| | | ||
| - | ===== Atualiza uma promoção ===== | + | ===== Atualizar promoção ===== |
| - | Método para atualizar uma promoção | + | Método para atualizar uma promoção. |
| <html> | <html> | ||
| Linha 305: | Linha 326: | ||
| <td>string</td> | <td>string</td> | ||
| <td>Data de início da promoção</td> | <td>Data de início da promoção</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>expires_at</td> | ||
| + | <td>string</td> | ||
| + | <td>Data de término da promoção</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>flash_offer_enabled</td> | ||
| + | <td>boolean</td> | ||
| + | <td>Oferta relâmpago ativa (Campo expires_at é obrigatório)</td> | ||
| </tr> | </tr> | ||
| <tr> | <tr> | ||
| Linha 321: | Linha 352: | ||
| "percent_off": 10, | "percent_off": 10, | ||
| "quantity_limit": 0, | "quantity_limit": 0, | ||
| - | "starts_at": "2024-05-22 15:45:00", | + | "starts_at": "2024-05-22 15:45:00 |
| + | "expires_at": "2024-05-23 15:45:00", | ||
| + | "flash_offer_enabled": true, | ||
| "active": true | "active": true | ||
| } | } | ||
| | | ||
| - | ===== 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 392: | ||
| </html> | </html> | ||
| - | ===== Adiciona uma compra ===== | + | ===== Adicionar compra ===== |
| - | Método para adicionar uma compra | + | Método para adicionar uma compra. |
| <html> | <html> | ||
| Linha 426: | Linha 459: | ||
| <td>string</td> | <td>string</td> | ||
| <td>Número do cupom</td> | <td>Número do cupom</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>coupons</td> | ||
| + | <td>array</td> | ||
| + | <td>Lista com os IDS dos cupons utilizados na compra</td> | ||
| </tr> | </tr> | ||
| <tr> | <tr> | ||
| Linha 440: | Linha 478: | ||
| <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 484: | ||
| <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 524: | Linha 567: | ||
| "pdv": "1", | "pdv": "1", | ||
| "coupon": "15", | "coupon": "15", | ||
| + | "coupons": [4,5,8], | ||
| "operator": "Manu", | "operator": "Manu", | ||
| "payments": [ | "payments": [ | ||
| Linha 530: | Linha 574: | ||
| "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 596: | ||
| ===== Cancelar compra ===== | ===== Cancelar compra ===== | ||
| - | Método para cancelar uma compra | + | Método para cancelar uma compra. |
| <html> | <html> | ||
| Linha 633: | Linha 678: | ||
| ===== 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 690: | ||
| <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 673: | Linha 731: | ||
| <td>string</td> | <td>string</td> | ||
| <td>CPF/CNPJ do consumidor</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> | ||
| <tr> | <tr> | ||
| Linha 766: | Linha 849: | ||
| <td>number</td> | <td>number</td> | ||
| <td>Desconto total a ser aplicado no item da venda</td> | <td>Desconto total a ser aplicado no item da venda</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>coupons.coupon_id</td> | ||
| + | <td>number</td> | ||
| + | <td>ID do cupom a ser aplicado na compra</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>coupons.discount_type</td> | ||
| + | <td>string</td> | ||
| + | <td>Tipo do desconto (PERCENT ou VALUE)</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>coupons.value</td> | ||
| + | <td>number</td> | ||
| + | <td>Valor do desconto</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>coupons.is_stackable</td> | ||
| + | <td>boolean</td> | ||
| + | <td>Cupom acumulativo para mesma compra</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>coupons.discount</td> | ||
| + | <td>number</td> | ||
| + | <td>Valor final do desconto a ser aplicado na compra</td> | ||
| </tr> | </tr> | ||
| </tbody> | </tbody> | ||
| Linha 775: | Linha 883: | ||
| { | { | ||
| "consumer": "53933515009", | "consumer": "53933515009", | ||
| + | "date": "2024-06-19", | ||
| + | "pdv": "1", | ||
| + | "coupon": "1", | ||
| + | "reference": "1", | ||
| + | "type": "DAV" | ||
| "items": [ | "items": [ | ||
| { | { | ||
| Linha 794: | Linha 907: | ||
| "total_shoppings": 152.99, | "total_shoppings": 152.99, | ||
| "count_shoppings": 7, | "count_shoppings": 7, | ||
| + | "digital_change": 0, | ||
| "total_discounts": 15 | "total_discounts": 15 | ||
| }, | }, | ||
| Linha 805: | Linha 919: | ||
| } | } | ||
| } | } | ||
| + | "coupons": [{ | ||
| + | "coupon_id": 4, | ||
| + | "discount_type": "PERCENT", | ||
| + | "value": 7.5, | ||
| + | "is_stackable": true, | ||
| + | "discount": 0.75 | ||
| + | }], | ||
| } | } | ||
| Linha 849: | Linha 970: | ||
| <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 854: | Linha 980: | ||
| <td>string</td> | <td>string</td> | ||
| <td>Número de referência</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> | ||
| <tr> | <tr> | ||
| Linha 865: | Linha 1006: | ||
| { | { | ||
| - | "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> | ||
integracao_easypromo.1718904057.txt.gz · Última modificação: 2024/06/20 17:20 por rafael
Ferramentas da página
