API Reference
Log In
API Reference

Este hook é disparado quando um novo status de transporte do pedido é criado.

CampoTipoDescrição
orderNumberstringIdentificador do pedido.
createdAtdatetimeData em que o pedido foi criado
estimateDeliveryDatedatetimePrevisão de entrega do pedido
shippedAtdatetimeData em que o pedido foi despachado para transportadora
deliveryTypestringTipo de entrega
sourceTypestringCanal de origem do pedido
- senderobjectObjeto com informações do ponto de origem do pedido
namestringNome do ponto de origem
codestringCódigo do ponto de origem
employerNumberstringCNPJ do ponto de origem
- receiverobjectObjeto com informações do destinatário
namestringNome do destinatário
emailstringE-mail do destinatário
documentstringDocumento do destinatário
stateInscriptionstringInscrição estadual do destinatário
phonestringTelefone do destinatário
isCorporatebooleanFlag que indica se o destinatário é uma empresa
- addressobjectObjeto com endereço de entrega
citystringCidade do endereço de entrega
statestringEstado do endereço de entrega
numberstringNúmero do endereço de entrega
postalCodestringCEP do endereço de entrega
streetAddressstringEndereço de entrega
neighborhoodstringBairo do endereço de entrega
complementstringComplemento do endereço de entrega
referencestringInformação complementar para auxiliar o entregador
latitudenumberLatitude do endereço de entrega
longitudenumberLongitude do endereço de entrega
- carrierobjectObjeto com informações da transportadora
namestringNome da transportadora
externalCodestringCódigo da transportadora
employerNumberstringCNPJ da transportadora
stateInscriptionstringInscrição estadual da transportadora
- invoiceobjectObjeto com informações sobre faturamento
numberstringNúmero do documento fiscal
keystringChave do documento fiscal
serialNumberstringNúmero de série do documento fiscal
issuedAtdatetimeData da emissão do documento fiscal
authorizationProtocolstringProtocolo de autorização do documento fiscal
- lastEventobjectObjeto com informações do status de transporte
idstringIdentificador único do status
statusstringStatus de transporte
statusRawstringStatus de transporte recebido da transportadora
eventDatedatetimeData do evento
createdAtdatetimeData em que o status foi recebido
trackingUrlstringUrl para rastreamento do pedido
trackingCodesarrayCódigos de rastreio do pedido
isEndProcessesbooleanFlag que indica se o processo de transporte foi finalizado

Exemplo do corpo da requisição que será enviada.

{
   "orderNumber":"1234567890",
   "createdAt":"2024-05-26T12:18:25.1870000Z",
   "estimateDeliveryDate":"2024-05-27T15:18:17.8400000Z",
   "shippedAt":"2024-05-27T12:31:45.2770000Z",
   "deliveryType":"ER",
   "sourceType":"Ecommerce",
   "sender":{
      "name":"Loja Matriz",
      "code":"loja-matriz",
      "employerNumber":"11111111000111"
   },
   "receiver":{
      "name":"José Silva",
      "email":"[email protected]",
      "document":"01234567890",
      "stateInscription":null,
      "phone":"+5511999999999",
      "isCorporate":null,
      "address":{
         "city":"São Paulo",
         "state":"SP",
         "number":"2529",
         "postalCode":"01227-200",
         "streetAddress":"Avenida Angélica",
         "neighborhood":"Bela Vista",
         "complement":null,
         "reference":null,
         "latitude":"-99.2418479",
         "longitude":"-99.4320793"
      }
   },
   "carrier":{
      "name":"Entrega Rápida",
      "externalCode":"rapida",
      "employerNumber":"11111111111111",
      "stateInscription":null
   },
   "invoice":{
      "number":"00000",
      "key":"00000000000000000000000000000000000000000",
      "serialNumber":"2",
      "issuedAt":"2024-05-26T00:00:00.0000000Z",
      "authorizationProtocol":null
   },
   "lastEvent":{
      "id":"936b4090-42aa-497a-bf58-449564a9f564",
      "status":"Delivered",
      "statusRaw":"Delivered",
      "eventDate":"2024-05-27T16:15:00.0000000Z",
      "createdAt":"2024-05-27T17:00:24.8230000Z",
      "trackingUrl": "https://encontreseupedido.logstore.com.br/t=xxxxxxxxxxx",
      "trackingCodes":[
         "xxxxxxxxxxx"
      ],
      "isEndProcesses":true
   }
}