Customer orders

List customer orders with their product lines and the stock lots they are booked from, optionally filtered by available attributes. Archived and cancelled customer orders are left out unless the request filters by customer_order_id or by status. Product filters must match the same order line. Matching orders are returned with all their product lines.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params

Database ID(s) of the customer order. One value or a list, for example ?customer_order_id=1 or ?customer_order_id[]=1&customer_order_id[]=2. Archived and cancelled customer orders are returned when this filter is given.

string | null

A unique number to identify the customer order. Partial match.

string | null

Reference of the customer order. Partial match.

integer | null

Database ID of the customer.

string | null

A unique number to identify the customer. Partial match.

string | null

A name of the customer. Partial match.

string | null

Email address of the customer. Partial match against any of the customer's e-mail addresses.

integer | null

Sales person who handles that customer order.

integer | null

Database ID of the account manager.

integer | null

Database ID of the pricelist.

string | null

A unique number to identify the pricelist. Partial match.

string | null

A name of the pricelist. Partial match.

integer | null

ID of customer order shipping address if it is selected in customer order details.

string | null

Shipping address selected in customer order details. Partial match; a country name or ISO code also matches structured addresses in that country.

enum

Status of customer order. One value or a list, for example ?status=10 or ?status[]=10&status[]=20. Archived and cancelled customer orders are returned when this filter is given.


  • 10 - Quotation
  • 20 - Waiting for confirmation
  • 30 - Confirmed
  • 40 - Waiting for production
  • 50 - In production
  • 60 - Ready for shipment
  • 70 - Shipped
  • 80 - Delivered
  • 85 - Archived
  • 90 - Cancelled
enum

Product status of customer order. One value or a list, for example ?part_status=10 or ?part_status[]=10&part_status[]=20.


  • 10 - Not booked
  • 12 - Not enough
  • 15 - Requested
  • 20 - Delayed
  • 25 - Possibly delayed
  • 30 - Expected on time
  • 40 - Ready for shipment
  • 50 - Delivered
enum

Invoice status of customer order. One value or a list, for example ?invoice_status=10 or ?invoice_status[]=10&invoice_status[]=20.


  • 10 - Not invoiced
  • 20 - Partially invoiced
  • 30 - Invoiced
enum

Payment status of customer order. One value or a list, for example ?payment_status=10 or ?payment_status[]=10&payment_status[]=20.


  • 10 - Not paid
  • 20 - Partially paid
  • 30 - Paid
string | null

A unique number to identify the stock lot the products are booked from. Partial match; cancelled lots are left out.

string | null

Code of the source manufacturing order, purchase order, transfer order or RMA order the products are booked from. Partial match; cancelled orders are left out.

string | null

Internal notes, any additional information about the order. Partial match.

string | null

Delivery terms of the order: the text of a configured term, matched regardless of case, or its ID. Any other value is refused.

string | null

Minimum total price of the customer order in the account default currency.

string | null

Maximum total price of the customer order in the account default currency.

string | null

Minimum total price of the customer order in the order's currency.

string | null

Maximum total price of the customer order in the order's currency.

string | null

Minimum total cost of the customer order in the account default currency.

string | null

Maximum total cost of the customer order in the account default currency.

string | null

Minimum profit of the customer order in the account default currency. May be negative.

string | null

Maximum profit of the customer order in the account default currency. May be negative.

string | null

Minimum markup or margin percentage, as the profit calculation is configured in the account. May be negative.

string | null

Maximum markup or margin percentage, as the profit calculation is configured in the account. May be negative.

string | null

Minimum unallocated prepayment amount in the account default currency.

string | null

Maximum unallocated prepayment amount in the account default currency.

string | null

Minimum unallocated prepayment amount in the order's currency.

string | null

Maximum unallocated prepayment amount in the order's currency.

integer | null

Minimum creation date and time as UNIX timestamp.

integer | null

Maximum creation date and time as UNIX timestamp. The whole of that day is covered.

integer | null

Minimum planned delivery date and time as UNIX timestamp.

integer | null

Maximum planned delivery date and time as UNIX timestamp. The whole of that day is covered.

integer | null

Minimum available-from date and time as UNIX timestamp.

integer | null

Maximum available-from date and time as UNIX timestamp. The whole of that day is covered.

integer | null

Minimum actual delivery date and time as UNIX timestamp.

integer | null

Maximum actual delivery date and time as UNIX timestamp. The whole of that day is covered.

string | null

A unique number to identify the stock item. Partial match.

string | null

Name of the stock item. Partial match.

string | null

Minimum ordered quantity of a product.

string | null

Maximum ordered quantity of a product.

string | null

Minimum shipped quantity of a product.

string | null

Maximum shipped quantity of a product.

custom_values
array of objects | null

Conditions on custom fields of the customer order or of its customer. All of them must hold. Example for a text field: ?custom_values[0][field_id]=1&custom_values[0][value]=abc. Replace 1 with your custom field ID; use indices 0, 1, etc. for separate conditions.

custom_values
integer

Maximum number of records to return (1–1000).

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json