order

order.list

Get list of orders from store.

get/order.list.json

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

startinteger

This parameter sets the number from which you want to get entities

countinteger

This parameter sets the entity amount that has to be retrieved. Max allowed count=250

page_cursorstring

Used to retrieve orders via cursor-based pagination (it can't be used with any other filtering parameter)

idsstring

Retrieves orders specified by ids

order_idsstring

Retrieves orders specified by order ids

since_idstring

Retrieve entities starting from the specified id.

store_idstring

Store Id

vendor_idstring

Retrieves orders specified by vendor id

customer_idstring

Retrieves orders specified by customer id

customer_emailstring

Retrieves orders specified by customer email

basket_idstring

Retrieves order’s info specified by basket id.

currency_idstring

Currency Id

phonestring

Filter orders by customer's phone number

order_statusstring

Retrieves orders specified by order status

order_status_idsstring[]

Retrieves orders specified by order statuses

ebay_order_statusstring

Retrieves orders specified by order status

financial_statusstring

Retrieves orders specified by financial status

financial_status_idsstring[]

Retrieves orders specified by financial status ids

fulfillment_statusstring

Create order with fulfillment status

return_statusstring

Retrieves orders specified by return status

fulfillment_channelstring

Retrieves order with a fulfillment channel

shipping_methodstring

Retrieve entities according to shipping method

skip_order_idsstring

Skipped orders by ids

is_deletedboolean

Filter deleted orders

shipping_country_iso3string

Retrieve entities according to shipping country

delivery_methodstring

Retrieves order with delivery method

ship_node_typestring

Retrieves order with ship node type

created_tostring

Retrieve entities to their creation date

created_fromstring

Retrieve entities from their creation date

modified_tostring

Retrieve entities to their modification date

modified_fromstring

Retrieve entities from their modification date

tagsstring

Order tags

sort_bystring

Set field to sort by

sort_directionstring

Set sorting direction

paramsstring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve

response_fieldsstring

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.

excludestring

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

enable_cacheboolean

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_latest_api_versionboolean

Use the latest platform API version

rounding_precisioninteger
<p>Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).</p> <p>Supported values range from <b>1</b> to <b>6</b>.</p> <p>The default rounding precision may vary depending on the platform. You can retrieve the default value using the <strong>cart.info</strong> method in the <code>default_rounding_precision</code> field. </p><p>Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.</p>
allow_user_defined_order_statusesboolean

Indicates whether custom (user-defined) order statuses should be included in the response.

Response

successful operation

return_codeinteger nullable
return_messagestring nullable
additional_fieldsobject nullable
custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.