GET order.list.json

basket_id (string, query, optional)

Retrieves order’s info specified by basket id.

count (integer, query, optional, default: 10)

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

created_from (string, query, optional)

Retrieve entities from their creation date

created_to (string, query, optional)

Retrieve entities to their creation date

currency_id (string, query, optional)

Currency Id

customer_email (string, query, optional)

Retrieves orders specified by customer email

customer_id (string, query, optional)

Retrieves orders specified by customer id

delivery_method (string, query, optional)

Retrieves order with delivery method

ebay_order_status (string, query, optional)

Retrieves orders specified by order status

enable_cache (boolean, query, optional, default: False)

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)

exclude (string, query, optional)

Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all

financial_status (string, query, optional)

Retrieves orders specified by financial status

fulfillment_status (string, query, optional)

Create order with fulfillment status

ids (string, query, optional)

Retrieves orders specified by ids

is_deleted (boolean, query, optional)

Filter deleted orders

modified_from (string, query, optional)

Retrieve entities from their modification date

modified_to (string, query, optional)

Retrieve entities to their modification date

order_ids (string, query, optional)

Retrieves orders specified by order ids

order_status (string, query, optional)

Retrieves orders specified by order status

order_status_ids (array, query, optional)

Retrieves orders specified by order statuses

page_cursor (string, query, optional)

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

params (string, query, optional, default: order_id,customer,totals,address,items,bundles,status)

Set this parameter in order to choose which entity fields you want to retrieve

phone (string, query, optional)

Filter orders by customer's phone number

response_fields (string, query, optional)

Set this parameter in order to choose which entity fields you want to retrieve

ship_node_type (string, query, optional)

Retrieves order with ship node type

shipping_country_iso3 (string, query, optional)

Retrieve entities according to shipping country

shipping_method (string, query, optional)

Retrieve entities according to shipping method

since_id (integer, query, optional)

Retrieve entities starting from the specified id.

skip_order_ids (string, query, optional)

Skipped orders by ids

sort_by (string, query, optional, default: order_id)

Set field to sort by

sort_direction (string, query, optional, default: asc)

Set sorting direction

start (integer, query, optional, default: 0)

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

store_id (string, query, optional)

Store Id