Iniciar entrega

Header obrigatório. Toda chamada exige o header x-abbiamo-seller-group-key. Preencha-o no canto superior direito desta página ou veja como obter a sua chave.

Update order to On Route

Eventos sequenciais não podem ter o mesmo event_at. Se você enviar um payload com o mesmo event_at de um evento anterior, ele não será processado.

Authorization

sec0

x-abbiamo-carrier-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

delivery_id*string

Identificador da entrega a ser atualizado

event_at*string

Data/hora do evento no formato ISO 8601 com timezone. Ex.: 2022-12-15T12:15:08.060-03:00

external_id?string

Identificador no seu sistema, pra que ambas as empresas possam referenciar a mesma entrega

support_id?string

Caso você tenha um identificador diferente para o time de suporte

observation?string

Informações adicionais sobre o evento. Máx. 400 caracteres

driver_name?string

Nome do motorista que está realizando a entrega

driver_phone?string

Telefone do motorista que está realizando a entrega

driver_document?string

Documento do motorista que está realizando a entrega

driver_vehicle_type?string

Tipo de veículo usado na entrega, exibido na página de tracking

Default"MOTORCYCLE"

Value in"PEDESTRIAN" | "BICYCLE" | "CAR" | "MOTORCYCLE"

driver_vehicle_color?string

Cor aplicada ao veículo na página de tracking. Pode ser nome de cor CSS ou hex

Default"black"

driver_vehicle_plate?string

Identificação do veículo, pra ajudar o cliente final no momento da entrega

driver_image_url?string

Foto de perfil do motorista exibida na página de tracking

event_latitude?number

Latitude do motorista no momento do checkpoint (separador: ponto)

Formatfloat

event_longitude?number

Longitude do motorista no momento do checkpoint (separador: ponto)

Formatfloat

delivery_eta?string

ETA do evento no endereço de destino no formato ISO 8601 com timezone. Ex.: 2022-12-19T13:02:28.012-03:00

preview_delivery_price?integer

Preço estimado cobrado da loja por essa entrega

Formatint32

return_verification_code?string

Código alfanumérico que o motorista deve digitar no app (informado pelo lojista) para finalizar o processo de devolução, por segurança

Response Body

`application/json`

curl -X POST "https://example.com/v1/delivery/start-delivery" \  -H "Content-Type: application/json" \  -d '{    "delivery_id": "string",    "event_at": "string"  }'

"{\n  \"success\": true\n}"

"{}"

Authorization

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`