Callback - Notificação de pedido
Algumas informações durante o fluxo de venda do Marketplace podem ser consultadas diretamente do lojista.
Para isso, é permitido ao integrador expor sua própria API, com operações específicas que serão chamadas em determinados momentos pelo Marketplace.
Lembrando que, apenas integradores que consigam garantir requisitos não funcionais básicos como latência e disponibilidade mínima poderão implementar essa API.
Dados de entrada
Os seguintes tipos de eventos de notificação de pedidos serão enviados pelo Marketplace:
Método: POST
https://<dominio_lojista>/<uri_opcional>
• NEW: Criação de novo pedido
• APPROVED: Aprovação de um pedido
• CANCELED: Cancelamento de pedido pré-emissão fiscal
• RETURNED: Cancelamento de pedido pós-emissão fiscal
• SENT: Envio de um pedido (Apenas para pedidos Envvias)
• DELIVERED: Entrega de um pedido (Apenas para pedidos Envvias)
| Campo | Tipo | Descrição |
|---|---|---|
| eventDate | Data e Hora | Data de ocorrência do evento notificado |
| sellerId | Numérico Inteiro | Identificador do Lojista |
| eventType | Texto | Tipo do evento ocorrido para a ordem notificada. Valores permitidos: NEW, APPROVED, CANCELED, RETURNED, SENT ou DELIVERED |
| resourceType | Texto | Recurso da API que foi afetado. Nesse caso, será 'Orders' |
| resourceId | Numérico Inteiro | Identificador da ordem afetada |
| uriResource | Texto | URI para consulta do recurso afetado |
Exemplo de Request
Para todo pedido criado no Marketplace, um evento é gerado. Sendo assim, é enviada a seguinte mensagem para a URL de Callback cadastrada:
{
"eventDate" : "2022-06-30T17:21:00.000-03:00",
"sellerId" : 3,
"eventType" : "New",
"resourceType" : "Orders",
"resourceId" : 300000000001,
"uriResource" : "/orders/300000000001"
}
Regras para a utilização
• As notificações de eventos devem ser processadas de forma assíncrona pelo lojista ou integrador.
• É realizado o reenvio do evento, caso sua aplicação esteja indisponível. São realizadas 5 tentativas e, não havendo sucesso, o envio do evento é cancelado.
Importante
Consultando a lista de pedidos novos GET /orders/status/new duas vezes ao dia, você conseguirá garantir que caso ocorra alguma falha no envio de evento de um novo pedido, o mesmo não deixará de ser integrado no seu sistema. Os eventos são apenas notificações. Para obter as informações é necessário buscá-las no serviço relacionado ao evento recebido, que fica disponível no campo uriResource
Configuração
O cadastro da URL disponibilizada pelo integrador deve ser inserido no PAS (Portal admin seller) pelo próprio parceiro.
