Configurando o WebHook no Plug4Market
O Plug4Market utiliza o método POST para enviar pedidos sempre que eles são criados para a URL previamente configurada. Cada requisição inclui um corpo JSON específico, que será detalhado a seguir.
Status de Pedidos - Webhook
O webhook enviará atualizações conforme o status de um pedido for alterado. Os seguintes estados, em ordem de progressão, estão disponíveis:
- CREATED: O pedido foi criado.
- APPROVED: O pedido foi aprovado.
- INVOICED: O pedido foi faturado.
- SHIPPED: O pedido foi enviado.
- COMPLETED: O pedido foi concluído com sucesso.
-
CANCELED: O pedido foi cancelado.
Esses eventos representam as etapas principais do ciclo de vida de um pedido.
Exemplo: CREATED.
{
"softwareHouseCnpj": "95623143000166", // CNPJ da Software House
"order": {
"status": "CREATED", // STATUS DO PEDIDO
"orderId": "46a3ebc9-a880-40a0-a6a5-78d8e16d69c7", // ID do pedido
"storeCnpj": "40741047000120" // CNPJ da loja que recebeu o pedido
},
"webhookName": "Webhook-teste", // Nome do Webhook cadastrado
"id": "6a217882-f235-4def-b0d3-d453e9c8f82a", // ID do Webhook no Plug4Market
"resourceUrl": "https://api.sandbox.plug4market.com.br/orders/46a3ebc9-a880-40a0-a6a5-78d8e16d69c7" // URL do recurso
}
Exemplo: APPROVED.
{
"softwareHouseCnpj": "95623143000166", // CNPJ da Software House
"order": {
"status": "APPROVED", // STATUS DO PEDIDO
"orderId": "d71a702b-e9ee-42eb-b51c-6f9f76acdc0e", // ID do pedido
"storeCnpj": "40741047000120" // CNPJ da loja que recebeu o pedido
},
"webhookName": "Webhook-teste", // Nome do Webhook cadastrado
"id": "6a217882-f235-4def-b0d3-d453e9c8f82a", // ID do Webhook no Plug4Market
"resourceUrl": "https://api.sandbox.plug4market.com.br/orders/d71a702b-e9ee-42eb-b51c-6f9f76acdc0e" // URL do recurso
}
Exemplo: INVOICED.
{
"softwareHouseCnpj": "95623143000166", // CNPJ da Software House
"order": {
"status": "INVOICED", // STATUS DO PEDIDO
"orderId": "d71a702b-e9ee-42eb-b51c-6f9f76acdc0e", // ID do pedido
"storeCnpj": "40741047000120" // CNPJ da loja que recebeu o pedido
},
"webhookName": "Webhook-teste", // Nome do Webhook cadastrado
"id": "6a217882-f235-4def-b0d3-d453e9c8f82a", // ID do Webhook no Plug4Market
"resourceUrl": "https://api.sandbox.plug4market.com.br/orders/d71a702b-e9ee-42eb-b51c-6f9f76acdc0e" // URL do recurso
}
Exemplo: SHIPPED.
{
"softwareHouseCnpj": "95623143000166", // CNPJ da Software House
"order": {
"status": "SHIPPED", // STATUS DO PEDIDO
"orderId": "d71a702b-e9ee-42eb-b51c-6f9f76acdc0e", // ID do pedido
"storeCnpj": "40741047000120" // CNPJ da loja que recebeu o pedido
},
"webhookName": "Webhook-teste", // Nome do Webhook cadastrado
"id": "6a217882-f235-4def-b0d3-d453e9c8f82a", // ID do Webhook no Plug4Market
"resourceUrl": "https://api.sandbox.plug4market.com.br/orders/d71a702b-e9ee-42eb-b51c-6f9f76acdc0e" // URL do recurso
}
Exemplo: COMPLETED.
{
"softwareHouseCnpj": "95623143000166", // CNPJ da Software House
"order": {
"status": "COMPLETED", // STATUS DO PEDIDO
"orderId": "d71a702b-e9ee-42eb-b51c-6f9f76acdc0e", // ID do pedido
"storeCnpj": "40741047000120" // CNPJ da loja que recebeu o pedido
},
"webhookName": "Webhook-teste", // Nome do Webhook cadastrado
"id": "6a217882-f235-4def-b0d3-d453e9c8f82a", // ID do Webhook no Plug4Market
"resourceUrl": "https://api.sandbox.plug4market.com.br/orders/d71a702b-e9ee-42eb-b51c-6f9f76acdc0e" // URL do recurso
}
Exemplo: CANCELED.
{
"softwareHouseCnpj": "95623143000166", // CNPJ da Software House
"order": {
"status": "CANCELED", // STATUS DO PEDIDO
"orderId": "c5b46b4f-0108-45b8-8b4f-e0310064e764", // ID do pedido
"storeCnpj": "40741047000120" // CNPJ da loja que recebeu o pedido
},
"webhookName": "Webhook-teste", // Nome do Webhook cadastrado
"id": "6a217882-f235-4def-b0d3-d453e9c8f82a", // ID do Webhook no Plug4Market
"resourceUrl": "https://api.sandbox.plug4market.com.br/orders/c5b46b4f-0108-45b8-8b4f-e0310064e764" // URL do recurso
}
Obs1: É possível cadastrar apenas um webhook por Software House. Os pedidos de cada um deles serão enviados no mesmo endpoint, sendo diferenciados pelo campo "orderId" e "storeCnpj".
IMPORTANTE
Certifique-se de que o seu endpoint é capaz de aceitar requisições POST.
Os endpoints servem para definir a URL que a instância do Plug4Market chamará quando um evento ocorrer.
Aqui estão as etapas para configurar o WebHook:
1. Acesse o menu Webhook :
2.Preencha os seguintes campos:
Nome do Webhook: Forneça um nome descritivo para o seu Webhook.
URL : Insira a URL da sua aplicação, por exemplo, https://seuwebhook.com.br.
Headers (opcional): Insira os headers que deverão ser enviados na requisição.
*Lembre-se de clicar em "Cadastrar" após preencher todos os campos obrigatórios.
Comentários
0 comentário
Por favor, entre para comentar.