Create a new delivery job

This endpoint is used to create ad-hoc or customized delivery jobs and provide flexibility in fleet management.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the Delivery Manager application that is making the request.

Body Params
string
required

A unique identifier assigned to each delivery job.

string
required

The unique identifier for the store associated with the delivery job.

string
required

A unique identifier that refers to the order being delivered.

item
array of objects
required

A list of items to be delivered. Each object contains details of an individual item.

item*
pickup
object

This contains details about the location where the courier collects the order. It includes contact information, address details, and any additional instructions related to the pickup process.

dropOff
object
required

This contains details about the location where the order is delivered. It includes recipient contact information, address details, coordinates, and any additional delivery instructions.

string
required

Represents the timestamp when the order was fully prepared and ready for pickup. It follows the ISO 8601 format (e.g., 2025-01-29T14:30:00Z). This helps coordinate the pickup timing with the courier.

string

Represents the timestamp when the delivery is planned to take place. It follows the ISO 8601 format (e.g., 2025-01-29T15:00:00Z). This helps coordinate the expected delivery time with the recipient.

string

A unique ID for the delivery service handling the order. It helps track which third-party provider is responsible for the delivery.

Response
201

Delivery job created successfully

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!