Get a list of orders.
GET
/orders/{direction}
200Roles
At least one of the roles below is required to access this endpoint.
FullAccessOrderAdminOrderReader
Parameters
| Name | Type | Description | Possible Values | |
|---|---|---|---|---|
| direction | Required | string | Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. | Incoming, Outgoing, All |
| buyerID | string | ID of the buyer. | --- | |
| supplierID | string | ID of the supplier. | --- | |
| from | string | Lower bound of date range that the order was created. | --- | |
| to | string | Upper bound of date range that the order was created. | --- | |
| search | string | Word or phrase to search for. | --- | |
| searchOn | array | Comma-delimited list of fields to search on. | ID, FromCompanyID, ToCompanyID, Comments | |
| searchType | string | Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. | AnyTerm, AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix | |
| sortBy | array | Comma-delimited list of fields to sort by. | DateSubmitted, DateCreated, ID, FromCompanyID, ToCompanyID, FromUserID, Status, DateApproved, DateDeclined, DateCanceled, DateCompleted, LastUpdated, Subtotal, ShippingCost, TaxCost, Gratuity, PromotionDiscount, Total, IsSubmitted, !DateSubmitted, !DateCreated, !ID, !FromCompanyID, !ToCompanyID, !FromUserID, !Status, !DateApproved, !DateDeclined, !DateCanceled, !DateCompleted, !LastUpdated, !Subtotal, !ShippingCost, !TaxCost, !Gratuity, !PromotionDiscount, !Total, !IsSubmitted | |
| page | integer | Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. | --- | |
| pageSize | integer | Number of results to return per page. Default: 20, max: 100. | --- | |
| filters | object | An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' | --- | |
Response Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| Items | array | --- | --- | --- | ||
| Meta | object | --- | --- | --- | ||