Orders: list
Fetches objects collection.

HTTP Request
GET https://shop.url/webapi/rest/orders
Parameters
Parameter	Type	Description
limit	integer	count of fetched objects, default: 10, max: 50
order	string	collection sort field
page	integer	index of requested page, default: 1
offset	integer	starting record index (used instead of page)
filters	string	JSON-ified string with filtering criteria
Sort fields
Parameter	Description
order_id	order identifier
user_id	client identifier
date	order creation date in format
status_date	date of the latest order status change in format
confirm_date	order confirmation date format
delivery_date	delivery date in format
status_id	order status identifier
status	order status data
status.status_id	status identifier
status.active	is status enabled
status.default	is status default
status.color	status color (hex)
status.type	one of following:
1 - new,
2 - opened,
3 - closed,
4 - not completed
status.email_change	notify on status change using e-mail?
status.order	status order
sum	order sum
payment_id	payment method identifier
loyalty_cost	loyalty points used for products exchange
user_order	has the order been created by registered user?
shipping_id	shipping identifier
shipping_cost	shipping cost
email	client 's e-mail address
delivery_code (deprecated)	delivery code
code	order confirmation code
confirm	is the order confirmed
notes	client notes
notes_priv	private administrator's notes
notes_pub	public administrator's notes
currency_id	currency identifier
currency_rate	currency rate, for default currency always 1
paid	paid amount
ip_address	client's IP address (xxx.xxx.xxx.xxx)
discount_client	client's discount (in percent)
discount_group	group discount (in percent)
discount_levels	order discount based on defined discount levels (Admin » Marketing » Discounts » Discounts thresholds)
discount_code	amount of discount code (in percent)
code_id	discount code identifier
lang_id	language identifier chosen during ordering
origin	order origin
0 - shop,
1 - facebook,
2 - mobile,
3 - allegro,
4 - webapi
5 - shop's control panel (since 5.8.22)
6 - authenticated admin shop order
8 - Google
100-111 - Apilo
vat_eu	is B2B order within the Intra-Community Supply of Goods (EU VAT)?
order_url	link to the order preview
payment_url	link to pay the order
is_paid	has order been paid?
is_underpayment	is the order been paid lower than order amount?
is_overpayment	is the order been paid greater than order amount?
total_products	total products count
total_parcels	total parcels count
use_shipping_address	should the default address be used for delivery if billing_address, billing_address_id, delivery_address, delivery_address_id are missing?
created_at	datetime information on object creation in ISO_8601 format
updated_at	datetime information on latest object modification in ISO_8601 format
Filtering criteria
Parameter	Description
order_id	order identifier
user_id	client identifier
date	order creation date in format
status_date	date of the latest order status change in format
confirm_date	order confirmation date format
delivery_date	delivery date in format
status_id	order status identifier
status	order status data
status.status_id	status identifier
status.active	is status enabled
status.default	is status default
status.color	status color (hex)
status.type	one of following:
1 - new,
2 - opened,
3 - closed,
4 - not completed
status.email_change	notify on status change using e-mail?
status.order	status order
sum	order sum
payment_id	payment method identifier
loyalty_cost	loyalty points used for products exchange
user_order	has the order been created by registered user?
shipping_id	shipping identifier
shipping_cost	shipping cost
email	client 's e-mail address
delivery_code (deprecated)	delivery code
code	order confirmation code
confirm	is the order confirmed
notes	client notes
notes_priv	private administrator's notes
notes_pub	public administrator's notes
currency_id	currency identifier
currency_rate	currency rate, for default currency always 1
paid	paid amount
ip_address	client's IP address (xxx.xxx.xxx.xxx)
discount_client	client's discount (in percent)
discount_group	group discount (in percent)
discount_levels	order discount based on defined discount levels (Admin » Marketing » Discounts » Discounts thresholds)
discount_code	amount of discount code (in percent)
code_id	discount code identifier
lang_id	language identifier chosen during ordering
origin	order origin
0 - shop,
1 - facebook,
2 - mobile,
3 - allegro,
4 - webapi
5 - shop's control panel (since 5.8.22)
6 - authenticated admin shop order
8 - Google
100-111 - Apilo
vat_eu	is B2B order within the Intra-Community Supply of Goods (EU VAT)?
order_url	link to the order preview
payment_url	link to pay the order
is_paid	has order been paid?
is_underpayment	is the order been paid lower than order amount?
is_overpayment	is the order been paid greater than order amount?
total_products	total products count
total_parcels	total parcels count
billing_address.firstname	
billing_address.lastname	
billing_address.company	
billing_address.tax_identification_number	tax identification number (NIP)
billing_address.city	city - name or GeolocationSubregion identifier
billing_address.postcode	
billing_address.street1	
billing_address.street2	
billing_address.state	state/district - name, code or GeolocationRegion identifier
billing_address.country	country - name, code or GeolocationCountry identifier
billing_address.phone	
billing_address.country_code	country code according to the ISO 639-1 format - it has a higher priority than country
delivery_address.firstname	
delivery_address.lastname	
delivery_address.company	
delivery_address.tax_identification_number	tax identification number (NIP)
delivery_address.city	city - name or GeolocationSubregion identifier
delivery_address.postcode	
delivery_address.street1	
delivery_address.street2	
delivery_address.state	state/district - name, code or GeolocationRegion identifier
delivery_address.country	country - name, code or GeolocationCountry identifier
delivery_address.phone	
delivery_address.country_code	country code according to the ISO 639-1 format - it has a higher priority than country
additional_fields	additional order fields: To filter by additional field, use: additional_fields:{ "=": {"": ""}} Example: {"additional_fields":{"=": {"5": "test"}}}
additional_fields.(n).value	additional field value
additional_fields.(n).field_id	additional field identifier
additional_fields.(n).type	field type:
1 - text,
2 - checkbox,
3 - drop down
additional_fields.(n).locate	Show in (bit mask):
8 - order field,
16 - with registration,
32 - without registration,
64 - signed in client
additional_fields.(n).req	is required?
additional_fields.(n).active	is active?
additional_fields.(n).order	sorting order
created_at	datetime information on object creation in ISO_8601 format
updated_at	datetime information on latest object modification in ISO_8601 format
API Scope
This method requires at least one of the following permissions:

orders_delete
orders_create
orders_read
orders_edit
HTTP Request body
This method doesn't expect any request body parameters

HTTP Response body
Upon successful request, the collection of objects is returned according to the following structure:

{
    "count": integer,
    "pages": integer,
    "page": integer,
    "list": [
        Resource
    ]
}
Parameter	Type	Description
count	integer	a count of objects satisfying criteria
pages	integer	count of pages with results
page	integer	number of current page
list	array	a collection of objects
ExamplePHP
try{
    $options = array(
        'entrypoint' => $entrypoint,
        'client_id' => $clientId,
        'client_secret' => $clientSecret,
        'access_token' => $accessToken
    );
    $client = DreamCommerce\ShopAppstoreLib\Client::factory('OAuth', $options);

    $resource = new DreamCommerce\ShopAppstoreLib\Resource\Order($client);
    $result = $resource->get();

    foreach($result as $r){
        printf("#%d - %.2f (@%s)\n", $r->order_id, $r->sum, $r->date);
    }
} catch(DreamCommerce\ShopAppstoreLib\Exception\Exception $ex) {
    die($ex->getMessage());
}