Sign in

Create a new delivery job

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

post/{aplicationId}/delivery-jobs

Path parameters

aplicationIdstring required

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

Request body

idstring required

A unique identifier assigned to each delivery job.

storeIdstring required

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

orderReferenceIdstring required

A unique identifier that refers to the order being delivered.

preparedAtstring 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.

scheduledAtstring

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.

deliveryPartnerIdstring

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

Response

Delivery job created successfully

Changes

No recorded changes to this endpoint across all 1 revision of this API.