v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Orders

Search orders

Search for one or more orders.

get/v1/Orders

Query parameters

search.order_idinteger[]

Query by order identifier.

search.customer_idinteger[]

Query by account identifier.

search.statusstring[]

Query by order status.

search.order_typestring[]

Query by kind of order.

search.ponstring[]

Query by all or part of purchase order number.

search.assigned_tointeger[]

Query by identifier of user assigned to order.

search.request_idinteger[]

Query by request identifier.

search.created_byinteger[]

Query by identifier of user who created the order.

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.status_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by status date.

search.status_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by status date.

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.