API Documentation

Create / Cancel Order

post
https://api.staging.deliverect.com//order/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to {channelName}

A unique scope provided to channel integrators to create orders in authorised locations

string
required
Defaults to {channelLinkId}

The unique identifier of the channel in a specific location.

Body Params
string
required

The full unique ID from the ordering channel.

string
required

A humanly-readable order reference.

string

Validation ID returned from dispatch validation when used.

integer
required

Order type. Use 1 for pickup, 2 for delivery, 3 for eat-in, and 4 for curbside.

boolean
string
string
string
string
required

Who delivers the order.

boolean
deliveryAddress
object
deliveryInfo
object
integer
payment
object
required
taxes
array of objects
taxes
integer
items
array of objects
items
boolean
string
boolean
string
integer
customer
object
integer
integer
integer
integer
integer
integer
integer
integer
discounts
array of objects
discounts
Responses
200

Successful response

Updated 19 days ago

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

Updated 19 days ago