Skip to main content
WEBHOOK
tracking-event
{
  "deliveryId": "48ae4d68-6626-11ed-9022-0242ac120002",
  "orderId": "52122852-6626-11ed-9022-0242ac120002",
  "orderDisplayId": "96b41025",
  "merchant": {
    "id": "22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824",
    "name": "Pizza Plaza"
  },
  "event": {
    "type": "PENDING",
    "datetime": "2023-11-07T05:31:56Z",
    "message": "<string>",
    "rejectionInfo": "<unknown>"
  },
  "customerName": "<string>",
  "problem": [
    {
      "reason": "DELIVERYPERSON_OCCURRENCE",
      "datetime": "2023-11-07T05:31:56Z",
      "canFinishDeliver": true,
      "needMerchantAction": true,
      "message": "<string>"
    }
  ],
  "vehicle": {
    "type": [
      "MOTORBIKE_BAG"
    ],
    "container": "NORMAL"
  },
  "deliveryPrice": {
    "price": {
      "value": 45.5,
      "currency": "BRL"
    },
    "pricingList": "NORMAL",
    "additionalPricePercentual": 123
  },
  "eta": {
    "updateMethod": "ONLINE",
    "pickupEtaInMinutes": 123,
    "pickupEtaDatetime": "2023-11-07T05:31:56Z",
    "deliveryEtaInMinutes": 123,
    "deliveryEtaDatetime": "2023-11-07T05:31:56Z",
    "maxDeliveryTime": "2023-11-07T05:31:56Z",
    "returnToMerchantEtaInMinutes": 123,
    "returnToMerchantEtaDatetime": "2023-11-07T05:31:56Z"
  },
  "deliveryPerson": {
    "id": "<string>",
    "name": "<string>"
  },
  "geoLocalization": {
    "latitude": -23.54809,
    "longitude": -46.63638
  }
}

Headers

X-App-Id
string<uuid>
required

Identificador único da Husky.

X-App-MerchantId
string
required

Um identificador único do Embarcador

Required string length: 36 - 100
Example:

"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824"

X-App-Signature
string<SHA256>
required

Hash SHA256 do corpo da requisição, usando o segredo do cliente como chave

Body

application/json

Novo evento

Objeto de evento de entrega

deliveryId
string<uuid>
required

O ID da entrega gerado pelo serviço de logística.

Example:

"48ae4d68-6626-11ed-9022-0242ac120002"

orderId
string<uuid>
required

O ID do pedido gerado pelo Aplicativo de Pedidos.

Example:

"52122852-6626-11ed-9022-0242ac120002"

orderDisplayId
string
required

ID do pedido exibido na interface do Aplicativo de Pedidos para o cliente.

Example:

"96b41025"

merchant
object
required

Informações do comerciante.

event
object
required

Informações do evento atual.

customerName
string
required

Nome do cliente.

problem
object[]

Lista de problemas que podem ocorrer.

vehicle
object

Informações do veículo escolhido.

Esta propriedade é OBRIGATÓRIA quando event > type é diferente de PENDING, REJECTED e CANCELLED

deliveryPrice
object

Informações de preço de entrega.

Esta propriedade é OBRIGATÓRIA quando event > type é diferente de PENDING, REJECTED e CANCELLED

eta
object

Tempos estimados de coleta e entrega.

Esta propriedade é OBRIGATÓRIA quando event > type é diferente de PENDING, REJECTED e CANCELLED

deliveryPerson
object

Informações do entregador. Caso a entrega esteja sem entregador, o campo id será preenchido com a string UNDEFINED.

geoLocalization
object

Informações de localização geográfica.

Response

204

Dados recebidos com sucesso. Nenhum conteúdo de resposta.