Envio de Pedido via API

Criada por Alex Camargo, Modificado em Ter, 5 Mar na (o) 11:45 AM por Alex Camargo

Ao enviar um pedido para a BonifiQ você permite que o consumidor seja bonificado, de acordo com as regras configuradas no Objetivo de Compra.

O endpoint de pedidos está na API Privada, no link:

https://api.bonifiq.com.br/apidocs/private/index.html?url=/swagger/Private%20APIs/swagger.json#/Order/Order_NewOrder


Status do Pedido

Dentro da BonifiQ nós temos 3 status em um pedido:

- Pendente: O pedido foi realizado mas ainda não deve receber pontos.

- Concluído: O pedido agora pode receber pontos 

- Cancelado: O pedido não irá receber pontos. Se ele já recebeu pontos, os pontos serão estornados.

Ao enviar os pedidos para a BonifiQ, você pode determinar em qual status esse pedido está.

Em geral, você pode enviar apenas pedidos já concluídos para a BonifiQ. 


Alguns pontos de atenção no envio dos campos:

- OriginalId: Esse é o ID do pedido no seu sistema. Ele é utilizado em diversos locais na BonifiQ, como envio de e-mail, relatório de pedidos, etc. Também é utilizado para atualizar este mesmo pedido, se necessário.

- OrderPlacementDate: Essa é a data que o pedido foi realizado no seu sistema. Deve ser enviado em formato UTC.

- OrderTotal: Esse é o valor líquido do pedido. Deve ser desconsiderados os descontos, promoções, cupons, vales, frete, etc. Esse é o valor que será utilizado como base para conceder os pontos.

- OrderStatus: Esse é o status do pedido na sua plataforma, pode ser qualquer texto. É diferente do Status da BonifiQ (vide cima). Utilizado em relatórios de pedido na BonifiQ.

- IsCompleted: Se true significa que o pedido está no status final Concluído (vide acima). Os pontos serão concedidos em até 24 horas após o recebimento do pedido. Quando esse campo é true, o campo "OrderCompletedDate" deve estar preenchido. 

- OrderCompletedDate: Data em que o pedido atingiu o status de concluído. Se IsCompleted=true, esse campo deverá ser preenchido, caso contrário ele deverá ser enviado como null.

- IsCancelledOrReturned: Indica se o pedido foi cancelado ou estornado (vide acima). Se ele for true, o campo "OrderCancelledDate" deverá ser preenchido. Se esse campo for true, o campo IsCompleted deve ser false.

- OrderCancelledDate: Data em que o pedido foi cancelado ou estornado. Deverá ser preenchido caso IsCancelledOrReturned=true. Caso contrário deverá ser null.

- Customer: Dados do consumidor que efetuou a compra. O campo OriginalId do Customer pode variar de acordo com a plataforma utilizada. Se for um uso online, ele deve ser o e-mail do cliente. Caso contrário deve ser o documento (CPF/CNPJ).

- Products: Opcional. Permite criar regras de pontuação por produto.

- Coupon: Código do cupom utilizado no resgate, se disponível

- Metadatas: Informações extras do pedido, se necessário.




Este artigo foi útil?

Que bom!

Obrigado pelo seu feedback

Desculpe! Não conseguimos ajudar você

Obrigado pelo seu feedback

Deixe-nos saber como podemos melhorar este artigo!

Selecione pelo menos um dos motivos

Feedback enviado

Agradecemos seu esforço e tentaremos corrigir o artigo