Tracking Event

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.

Show child attributes

merchant.id

string

required

Identificador único. Identifica o comerciante em diferentes sistemas que o comerciante comunicará.
Este ID deve ser gerado pelo Serviço de Software do comerciante.

Para evitar duplicatas entre diferentes comerciantes, é recomendado que o software crie o merchantId usando:
Documento do Comerciante + UUID

Se isso não for possível, é recomendado usar pelo menos um UUID.

Required string length: 36 - 100

Example:

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

merchant.name

string

required

Nome público do comerciante

Maximum string length: 500

Example:

"Pizza Plaza"

event

object

required

Informações do evento atual.

Show child attributes

event.type

enum<string>

required

O evento de entrega atual.

Available options:

PENDING,

ACCEPTED,

REJECTED,

PICKUP_ONGOING,

ARRIVED_AT_MERCHANT,

ORDER_PICKED,

DELIVERY_ONGOING,

ARRIVED_AT_CUSTOMER,

ORDER_DELIVERED,

RETURNING_TO_MERCHANT,

RETURNED_TO_MERCHANT,

DELIVERY_FINISHED,

CANCELLED

event.datetime

string<date-time>

required

Data e hora quando o evento ocorreu. padrão ISO 8601, timezone UTC.

event.message

string

Informado quando o evento é CANCELLED.

event.rejectionInfo

any

Informado quando o evento é REJECTED.

customerName

string

required

Nome do cliente.

problem

object[]

Lista de problemas que podem ocorrer.

Show child attributes

problem.reason

enum<string>

required

Motivo do problema.

Available options:

DELIVERYPERSON_OCCURRENCE,

PAYMENT_PROBLEMS,

WRONG_PRODUCT_OR_ITEM,

ORDER_DELAYED,

ORDER_DAMAGED_OR_VIOLATED,

CUSTOMER_DID_NOT_PLACE_ORDER,

CUSTOMER_ADDRESS_UNKNOWN,

ORDER_MISSING_ITEMS,

NOBODY_TO_RECEIVE,

DELIVERYPERSON_WAITING_PAYMENT_FOR_ALREADY_PAID_ORDER,

ORDER_DELIVERED_WITHOUT_PAYMENT,

FRAUD_OR_THEFT,

OTHER

problem.datetime

string<date-time>

required

Data e hora quando o problema ocorreu. padrão ISO 8601, timezone UTC.

problem.canFinishDeliver

boolean

required

Informa se ainda é possível finalizar a entrega.

problem.needMerchantAction

boolean

required

Informa se o comerciante precisa realizar alguma ação para que a entrega continue.

problem.message

string

Informações mais detalhadas sobre o problema.

vehicle

object

Informações do veículo escolhido.

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

Show child attributes

vehicle.type

enum<string>[]

required

Tipos de veículo aceitos para a entrega

Minimum array length: 1

Available options:

MOTORBIKE_BAG,

MOTORBIKE_BOX,

CAR,

BICYCLE,

SCOOTER,

VUC

Example:

["MOTORBIKE_BAG"]

vehicle.container

enum<string>

required

Tipo de container necessário

Available options:

NORMAL,

THERMIC

Example:

"NORMAL"

deliveryPrice

object

Informações de preço de entrega.

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

Show child attributes

deliveryPrice.price

object

required

Preço calculado da entrega na logistica.

Show child attributes

deliveryPrice.price.value

number<float>

required

Valor monetário

Required range: x >= 0

Example:

45.5

deliveryPrice.price.currency

enum<string>

required

Moeda. Padrão ISO 4217.

Available options:

BRL,

USD,

EUR

Required string length: 3

Example:

"BRL"

deliveryPrice.pricingList

enum<string>

required

Indica se o preço foi calculado com dinâmica ou normal.

Available options:

NORMAL,

DYNAMIC

deliveryPrice.additionalPricePercentual

number

required

Indica o percentual adicional da dinâmica.

eta

object

Tempos estimados de coleta e entrega.

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

Show child attributes

eta.updateMethod

enum<string>

required

Sempre enviamos como ONLINE.

Available options:

OFFLINE,

ONLINE

Example:

"ONLINE"

eta.pickupEtaInMinutes

integer

required

Tempo estimado de coleta em minutos.

eta.pickupEtaDatetime

string<date-time>

required

Data e hora estimada para coleta.

eta.deliveryEtaInMinutes

integer

required

Tempo estimado de entrega em minutos.

eta.deliveryEtaDatetime

string<date-time>

required

Data e hora estimada para entrega.

eta.maxDeliveryTime

string<date-time>

required

Data e hora máxima para entrega.

eta.returnToMerchantEtaInMinutes

integer

Tempo estimado de retorno ao mercado em minutos. Informado quando returnToMerchant é true.

eta.returnToMerchantEtaDatetime

string<date-time>

Data e hora estimada para retorno ao mercado. Informado quando returnToMerchant é true.

deliveryPerson

object

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

Show child attributes

deliveryPerson.id

string

required

Identificador único do entregador.

deliveryPerson.name

string

required

Nome do entregador.

geoLocalization

object

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

Show child attributes

geoLocalization.latitude

number<float>

required

Indica a coordenada de latitude da posição atual do entregador. Valores estão restritos ao intervalo [[-90, 90]].

Example:

-23.54809

geoLocalization.longitude

number<float>

required

Indica a coordenada de longitude da posição atual do entregador. Valores estão restritos ao intervalo [[-180, 180]].

Example:

-46.63638

Response

204

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

Introdução

Autenticação

Entregas

Detalhes da entrega

Cotação de entrega

Webhooks

Headers

Body

Response