post https://sandbox.api.deliverysolutions.co/api/v2/order/list
Use this API to retrieve the list of orders. By default, the orders placed within the last 24 hours will be retrieved.
* Both thepickupTimeanddropoffTimeare required when orders need to be retrieved based on either one of the parameter.
- All dates/Unix timestamps must be within last 1 year.
- If none of the input parameters are present, the system retrieves orders created in last 24 hours.
- If none of the date range fields are present (such as
lastUpdatedAt,createdAt,pickupTime,dropoffTime), the system automatically includescreatedAttime range for the last 24 hours in addition to the requested filters.
Response
Property | Type | Description |
|---|---|---|
paginationToken | Determines if there are more results than the | |
data | Array of Order | Array of Orders matching the search criteria |
Pagination TokenThe API has a limit of retrieving 1000 orders per call. If
limitvalue is specified in the request, the number of orders are retrieved as per the value indicated in the limit (limitcannot be more than 1000). Use thepaginationTokento navigate to the next or previous set of orders.
paginationTokenreturns an object ofnextandprevioustokens:
- If there are no results for the next page, the
nextvalue would be null.- If there are no results for the previous page, the
previousvalue would be null.- To navigate to the next set of page results, use the
nextvalue from thepaginationTokenresponse and set it as thepaginationTokenvalue.- To navigate to the previous set of page results, use the
previousvalue from thepaginationTokenresponse and set it as thepaginationTokenvalue.
