order.list
Get list of orders from store.
Request
- Base URL: https://api.api2cart.com/v1.1
- URL: https://api.api2cart.com/v1.1/order.list.json
- Auth: API key in header x-api-key and API key in header x-store-key
Query parameters
This parameter sets the number from which you want to get entities
This parameter sets the entity amount that has to be retrieved. Max allowed count=250
Used to retrieve orders via cursor-based pagination (it can't be used with any other filtering parameter)
Retrieves orders specified by ids
Retrieves orders specified by order ids
Retrieve entities starting from the specified id.
Store Id
Retrieves orders specified by vendor id
Retrieves orders specified by customer id
Retrieves orders specified by customer email
Retrieves order’s info specified by basket id.
Currency Id
Filter orders by customer's phone number
Retrieves orders specified by order status
Retrieves orders specified by order statuses
Retrieves orders specified by order status
Retrieves orders specified by financial status
Retrieves orders specified by financial status ids
Create order with fulfillment status
Retrieves orders specified by return status
Retrieves order with a fulfillment channel
Retrieve entities according to shipping method
Skipped orders by ids
Filter deleted orders
Retrieve entities according to shipping country
Retrieves order with delivery method
Retrieves order with ship node type
Retrieve entities to their creation date
Retrieve entities from their creation date
Retrieve entities to their modification date
Retrieve entities from their modification date
Order tags
Set field to sort by
Set sorting direction
Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve
Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.
Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all
If the value is 'true', we will cache orders for a 15 minutes in order to increase speed and reduce requests throttling for some methods and shoping platforms (for example order.shipment.add)
Use the latest platform API version
Indicates whether custom (user-defined) order statuses should be included in the response.
Response
successful operation
Changes
No recorded changes to this operation across all 1 revision of this API.