Get Delivery Config

Returns the delivery configuration for a given location

propertytypedescription
pickup_notesstringNotes set by the pickup location (store) to instruct drivers where to pickup the order upon arrival on site.

Notes are empty by default.
deliverable_actionstringDefault deliverable action setting to instruct driver on the how the order needs to be delivered to the customer.
"leave_at_door" is used for contactless deliveries.

Default deliverable action is to hand the order to the customer.
undeliverable_actionstringDefault action for the driver is unable to contact the customer to hand over the order.
"leave_at_door" is the default value.
dispatch_modestringMain dispatch setting controlling whether auto dispatching is enabled for this location or not. Used as a way to pause the dispatching process.

"external" sets all incoming orders to be dispatched to DSPs.

"manual" turns off auto- dispatching. Incoming orders are created but not dispatched.
service_providersarrayList of available DSPs for this location
default_requires_idbooleanSets the default value for the ID check requirement to be on / off by default for all deliveries.
requires_id_keywordsarrayList of string values which are checked against all order items. When a specified keyword is found in the order, ID check requirement is turned on for that order.
healthcheck_notificationsbooleanSwitches the notification alerts on / off for delayed orders.
late_pickup_notification_minsintegerNumber of minutes before an alert notification is sent out when a driver is late to pickup the order
late_dropoff_notification_minsintegerNumber of minutes before an alert notification is sent out when a driver is late to dropoff the order
Path Params
string
required
Responses

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