Purchase orders

List purchase orders with their product lines and incoming invoices, optionally filtered by available attributes. Cancelled and archived purchase orders are left out unless the request filters by purchase_order_id or by status.

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

Database ID of the purchase order. One value or a list, for example ?purchase_order_id=5 or ?purchase_order_id[]=5&purchase_order_id[]=6. Cancelled and archived purchase orders are returned when this filter is given.

string | null

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

integer | null

Database ID of the vendor.

string | null

A unique number to identify the vendor. Partial match.

string | null

A name of the vendor. Partial match.

enum

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


  • 5 - RFQ
  • 10 - New
  • 15 - Approved
  • 20 - Ordered
  • 30 - Shipped
  • 40 - Received
  • 110 - Archived
  • 120 - Cancelled
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 expected receipt date and time as UNIX timestamp.

integer | null

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

integer | null

Minimum arrival date and time as UNIX timestamp.

integer | null

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

integer | null

Minimum shipped date and time as UNIX timestamp.

integer | null

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

string | null

Order number that is received from the vendor. Partial match.

integer | null

Minimum vendor order date as UNIX timestamp.

integer | null

Maximum vendor order date as UNIX timestamp. The whole of that day is covered.

string | null

Invoice number that is received from the vendor. Partial match. Matches the purchase order's own invoice number or one of its incoming invoices.

integer | null

Minimum vendor invoice date as UNIX timestamp. Matches the purchase order's own invoice date or one of its incoming invoices.

integer | null

Maximum vendor invoice date as UNIX timestamp. The whole of that day is covered. Matches the purchase order's own invoice date or one of its incoming invoices.

integer | null

Minimum due date as UNIX timestamp. Matches the purchase order's own due date or one of its incoming invoices.

integer | null

Maximum due date as UNIX timestamp. The whole of that day is covered. Matches the purchase order's own due date or one of its incoming invoices.

string | null

Minimum total price of the purchase order in the default currency, including tax. Note that the published total_price_base is the total before tax.

string | null

Maximum total price of the purchase order in the default currency, including tax. Note that the published total_price_base is the total before tax.

string | null

Minimum total price of the purchase order in vendor's currency, including tax. Note that the published total_price_cur is the total before tax.

string | null

Maximum total price of the purchase order in vendor's currency, including tax. Note that the published total_price_cur is the total before tax.

string | null

A free text. Partial match.

custom_values
array of objects | null

Conditions on custom fields of the purchase order or of its vendor. 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