HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
API Documentation

Orders

get
https://api.staging.deliverect.com/my-orders

Retrieve orders for customer accounts linked to your Partner account. Each order includes the full order model, e.g. items, payment, customer and delivery details, and status history.

Polling Orders
Please note that frequent polling of orders is not allowed. To receive orders in real time as a POS, use the Order Notification webhook.

Query Params
string

Filter the results. Most attributes in the order object can be queried, passed as a JSON object, e.g. ?where={"account": "65********************6f"}.

  • By account – return all orders for a specified account.
  • By location – return all orders for a specified location.
  • By order ID – return the order matching the Deliverect order ID.

As results are paginated, please reference the Guide on Query Parameters which shows how to correctly handle paged results.

integer
≥ 1
Defaults to 1

Page number of the results to return.

integer
≥ 1
Defaults to 25

Number of results to return per page.

Response

Updated 8 days ago

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

Updated 8 days ago

Did this page help you?