Dispatch Details

Purpose

When a dispatch partner is assigned a delivery job, the details of the job can be queried via this endpoint.

Dispatch Integration Required
Delivery details are only available where a Dispatch partner is integrated with Deliverect. It does not return results from ordering platforms partners who handle delivery.

Path Parameters

AttributeDefinition
orderIdUnique identifier of the Deliverect order, will be returned asynchronously via Create / Cancel Order or retrievable with Get Checkout

Response parameters

The response includes the following delivery details;

AttributeDefinitionType
accountUnique identifier of the Deliverect account associated with the delivery.string
locationUnique identifier of the Deliverect location associated with the delivery.string
pickupTimeScheduled time for the courier to collect the order.string
pickupTimeETAEstimated time for the courier to collect the order.string
transportTypeTransport method used for the delivery.string
priceDelivery price.number
trackingURLURL for tracking the delivery with the dispatch provider, when availablestring
deliverectTrackingURLDeliverect tracking URL, when availablestring or null
deliveryTimeETAEstimated time when the order will be delivered.string

Tracking URL Availability
A tracking URL is returned only when supported by the Dispatch provider.

Courier Statuses

For a full list of all courier status values, see the link below;

Path Params
string
required

The unique Deliverect order Id

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json