HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
API Documentation

Dispatch Availability

post
https://api.staging.deliverect.com/fulfillment/validate

Purpose

Pre-validate courier availability across Dispatch partners before placing an order.

Dispatch Integration Required
a Dispatch provider needs to be integrated within a customer location for this endpoint to return courier availability.

Validation Id

A successful response with "available": true, will also include a"validationId" which is a unique ID (valid for 10 minutes) to be applied when creating an order, either via Checkout request (Commerce API) or Create / Cancel Order (Channel API)

When applying the validationId to an order, the originally validated address will be applied. To update to a new address, set validationId to null to trigger a new validation with the Dispatch provider.

Check availability for multiple stores

An array of channelLinkIds can be provided to determine the best possible pickup location for a specific delivery, based on price and distance.

In the examples on the right hand side, see "Dispatch Availability - Multiple Locations" where two stores are checked by their unique store identifier channelLinkId and the response "Offers Available - Multiple Stores" confirms the best pickup location to set for the order

When providing the array channelLinkIds , the "channelLinkId" field will be disregarded

A 200response only confirms that your request was successful; it does not confirm Dispatch availability. Always check the available flag in the response.

Body Params
string

The channelLinkId is the unique identifier of the channel (merchant store) in Deliverect. Provide either this field or channelLinkIds — if channelLinkIds is provided, this field is disregarded.

channelLinkIds
array of strings

An array of channelLinkId values, used to validate delivery availability across multiple pickup locations. Deliverect will determine the best possible pickup location for the delivery, based on price and distance. When this array is provided, the singular channelLinkId field is disregarded.

channelLinkIds
date-time

Expected time for the order to be picked up from the restaurant. Required only for future orders — if not provided, the current time is used. Time format is UTC yyyy-MM-ddTHH:mm:ssZ (all time values in this API are in UTC, as per ISO 8601).

deliveryLocations
object
required

Delivery details for the customer or end-user.

Responses

Updated 4 days ago

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

Updated 4 days ago

Did this page help you?