Inserir Status do Pedido
POST https://freterapido.com/api/tracking/orders
Através deste método é possível inserir um novo status do pedido conforme fluxo que desejar.
Observação:
- Caso já exista algum pedido/rastreio com as mesmas informações, ele será atualizado.
Envio:
Parâmetros da URL:
| Nome | Descrição | Formato/Exemplo | Obrigatório |
|---|---|---|---|
| token | Token de integração do embarcador ou transportadora | String | * |
| * Obrigatório |
Parâmetros do corpo da requisição:
| Nome | Descrição | Formato/Exemplo | Obrigatório |
|---|---|---|---|
| freightId | ID do frete | String | Opcional |
| orderNumber | Número do pedido | String | Opcional |
| invoiceKey | Chave de acesso da NF-e | String | Opcional |
| salesChannel | Canal de vendas | String | Opcional |
| finished | Se o pedido já foi finalizado. Importante para apresentar corretamente os status do pedido na página de rastreio. | Booleano | * |
| statuses | Lista de status do pedido | Array de objetos em json | * |
| status | Status do pedido | String | * |
| datetime | Data e hora da ocorrência | Datetime (YYYY-MM-DD HH:mm:ss) | * |
| recipient | Informações do destinatário. Importante para gerar notificações de novos status do pedido. | Array de objetos em json | Opcional |
| name | Nome do destinatário | String | * |
| Endereço de e-mail do destinatário | String | * | |
| phone | Telefone do destinatário | String | Opcional |
| registerNumber | Registro federal do destinatário (CNPJ ou CPF) | String | * |
| zipCode | CEP do destinatário | String | * |
| *Obrigatório |
Observação:
- Tanto freightId, orderNumber ou invoiceKey são obrigatórios desde que ao menos um deles seja informado.
Exemplo de envio:
{
"freightId": "",
"orderNumber": "",
"invoiceKey": "",
"salesChannel": "",
"finished": false,
"statuses": [
{
"status": "",
"datetime": "2021-02-01 14:35:00"
}
],
"recipient": {
"name": "",
"email": "",
"phone": "",
"registerNumber": "",
"zipCode": ""
}
}
- Se a requisição obtiver sucesso, retornaremos HTTP 201 (Created).