Search in documentation

Modules

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Solutions

Logistics

Introduction

The Logistics API manages delivery operations.

Receive orders

Query new orders every 30 seconds using:

Required for polling: Use the excludeHeartbeat parameter to prevent unintended store opening.Example: /events/v1.0/events:polling?excludeHeartbeat=true

Polling for order events

Configure polling to receive order events

Webhook for order events

Configure webhooks to receive order events

Get order details

Use GET logistics/orders/{id} to get order details.Responses:

200: Returns order data
404: Invalid ID or order not found

Order details

Check all available fields in the payload

Logistics actions

Assign driver

Use POST /assignDriver to assign a driver to the order.Required payload:

{
  "workerName": "José Maria",
  "workerPhone": "11999999999",
  "workerVehicleType": "MOTORCYCLE"
}

Valid values for workerVehicleType: BICYCLE, ONFOOT, PATINETE, EBIKE, SUPERBIKE, CAR, MOTORCYCLE, MOTORBIKE

Notify movement to pickup

Use POST /goingToOrigin when the driver starts moving to the pickup location.

Confirm arrival at origin

Use POST /arrivedAtOrigin when the driver arrives at the pickup location.

Notify movement to delivery

Use POST /dispatch when the driver starts moving to the delivery location.

Confirm arrival at destination

Use POST /arrivedAtDestination when the driver arrives at the delivery location.

Delivery verification

Send verification code

Required for all integrators.Use POST /verifyDeliveryCode to validate the delivery.Required payload:

{
  "code": "9999"
}

How it works:

Check if the order requires validation by the DELIVERY_DROP_CODE_REQUESTED event
Request the code from the recipient
Send the code via endpoint

Event example:

{
  "id": "f24e3b11-d292-48f0-a74b-e984575a1a0a",
  "code": "DDCR",
  "fullCode": "DELIVERY_DROP_CODE_REQUESTED",
  "orderId": "9c964c28-c833-44bb-9457-9b9accca3a6c",
  "merchantId": "b8ce1930-463b-4794-80b4-1823c261c1fb",
  "createdAt": "2023-04-17T17:56:39.029Z"
}

Was this page helpful?

Rate your experience in the new Developer portal:

On this page