Skip to main content

Enviar mensagem no pedido

Este recurso é responsável pelo envio de mensagens para um pedido específico que é passado na URL da requisição. A mensagem é recebida pelo cliente através da ferramenta de troca de mensagens em nossa plataforma.

Iniciando a sessão​

Altere o método da requisição para o tipo POST.

ordr1

Configurando a URL da requisição​

Nesse caso, devemos configurar a URL no endpoint /integrator/api/v1/orders/order-receive-message/{id_pedido}/

ordr2

Configurando a aba Authorization​

Na aba Authorization altere o Type para Bearer Token.

ordr3

Inserindo o token de autorização​

Insira seu token de autorização (obtido aqui).

ordr4

Inserindo a mensagem do pedido​

Insira a mensagem a respeito do pedido na aba Body>raw e clique em Send para enviar a mensagem.

Modelo de como os dados devem ser enviados
{
  "observation": "Sua mensagem"
}

Observação de cada campo e os tipos de dados aceitos em cada um:

CAMPOTIPOOBSERVAÇÃO
observationstring

ordr5

Retorno da requisição​

Retorno em caso de sucesso:
{
    "message": "Operation executed successfully!"
}

Erros que podem ser retornados​

STATUSCONTEÚDODESCRIÇÃO
403{"error": true, "detail": "Transition of status not allowed!"}Pedido não satisfaz o fluxo de status
403{"error": true, "detail": "Error updating order!"}Erro ao atualizar pedido
404{"error": true, "detail": "Order not exists!"}Pedido não existe