Get a list of order approvals.
GET
/orders/{direction}/{orderID}/approvals
200Description
Returns all Approvals associated with the Order.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessOrderAdminShopperOrderReader
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 |
orderID | Required | string | ID of the order. | --- |
search | string | Word or phrase to search for. | --- | |
searchOn | array | Comma-delimited list of fields to search on. | ApprovalRuleID, ApprovingGroupID, Approver, Comments | |
sortBy | array | Comma-delimited list of fields to sort by. | DateCreated, AllowResubmit, ApprovalRuleID, ApprovingGroupID, Status, DateCompleted, Approver, !DateCreated, !AllowResubmit, !ApprovalRuleID, !ApprovingGroupID, !Status, !DateCompleted, !Approver | |
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 | --- | --- | --- | ||