Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2478177179.1 KB

Get delivery job by ID

This endpoint is used to access detailed information about a specific delivery job using its unique identifier.

get/{aplicationId}/delivery-jobs/{deliveryJobId}

Path parameters

aplicationIdstring required

The unique identifier of the application that manages delivery jobs. This ID associates the request with the correct application context.

deliveryJobIdstring required

The unique identifier of the delivery job whose details you want to retrieve. This ID ensures the system fetches the correct delivery job record.

Response

Delivery job details

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.