Notificação de Pedidos

Nesta seção mostraremos a notificação de criação e atualização de pedidos para uma URL cadastrada pelo parceiro.

Esta funcionalidade ainda não está em Produção. Parceiros integrados devem aguardar comunicado quando a implementação for concluída.

Esta funcionalidade requer que a plataforma/ERP passe pelo processo de homologação da URL de notificação.

O que é a notificação de pedidos?

Quando um pedido é gerado ou tem seu status atualizado pelo marketplace a informação é notificada pela API para a URL cadastrada na conta do parceiro. Esta notificação contará com o código do pedido.

Em posse do código do pedido que foi gerado/atualizado (informação que, como mencionado, será disponibilizada no payload da notificação), caberá à plataforma/ERP a consulta dos dados da entrega.

O parceiro que optar pela notificação de pedidos não deverá mais utilizar a fila de integração (/queues/orders).

Criação e cadastro da URL

A plataforma/ERP deve criar um endpoint acessível via web e este deve ser capaz de receber requisições com o método POST.

Após a criação, a URL para recebimento da notificação precisa ser enviada para o e-mail [e-mail], assim nosso time realizará as configurações necessárias.

Notificações

A cada atualização de status ou recebimento de novos pedidos, a API realizará um POST para a URL cadastrada previamente, onde serão vistos os dados a seguir:

{
  "resource_id": "Lojas Americanas-1000000000006",
  "resource": "/orders/Lojas Americanas-1000000000006"
}

O código do pedido trata-se de um exemplo. A notificação enviará o pedido real oriundo do marketplace.

Uma vez que o POST tenha retornado sucesso, a mensagem de notificação é excluída de nossa fila.

Caso a URL esteja indisponível, serão executadas novas tentativas de realizar a notificação pelos próximos 3 dias.

GET - Consumindo o pedido

Após o recebimento da notificação contendo o código do pedido é preciso realizar um GET no endpoint /orders utilizando o resource_id informado no payload, conforme exemplo abaixo:

curl --location --request GET 'https://api.skyhub.com.br/orders/Lojas Americanas-1000000000006' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

Para maiores detalhes sobre a consulta individual de pedidos é possível acessar a documentação disponibilizada a guia Consulta de Pedidos desta documentação.