Get a list of order approvals

GET
/orders/{direction}/{orderID}/approvals

Description

Returns all Approvals associated with the Order.

Roles

At least one of the roles below is required to access this endpoint

FullAccess
OrderAdmin
Shopper
OrderReader

Parameters

NameTypeDescriptionPossible Values
directionstringDirection of the order, from the current user's perspective. Possible values: incoming, outgoing, all.Incoming, Outgoing, All
orderIDstringID of the order.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ApprovalRuleID, ApprovingGroupID, Approver, Comments
sortByarrayComma-delimited list of fields to sort by.DateCreated, AllowResubmit, ApprovalRuleID, ApprovingGroupID, Status, DateCompleted, Approver, !DateCreated, !AllowResubmit, !ApprovalRuleID, !ApprovingGroupID, !Status, !DateCompleted, !Approver
pageintegerPage 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.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAn 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

PropertyTypeFormatMax LengthPossible Values
Itemsarray---------
PropertyTypeFormatMax LengthPossible Values
AllowResubmit
Read Only
boolean---------

ApprovalRuleID
Read Only
string---------
ApprovingGroupID
Read Only
string---------
Status
Read Only
string------Pending, Approved, Declined
DateCreated
Read Only
stringdate-time------
DateCompleted
Read Only
stringdate-time------
Approver
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
Username
Read Only
string---100 characters---

Password
Read Only
stringpassword------
FirstName
Read Only
string---100 characters---
LastName
Read Only
string---100 characters---
Email
Read Only
string---200 characters---
Phone
Read Only
string---100 characters---
TermsAccepted
Read Only
stringdate-time------
Active
Read Only
boolean---------

xp
Read Only
object---------
AvailableRoles
Read Only
array---------

Locale
Read Only
object---------

PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
OwnerID
Read Only
string---------

Currency
Read Only
string---100 characters---

Language
Read Only
string---100 characters---

DateCreated
Read Only
stringdate-time------
PasswordLastSetDate
Read Only
stringdate-time------

Comments
Read Only
string---------
Metaobject---------
PropertyTypeFormatMax LengthPossible Values
Pageintegerint32------
PageSizeintegerint32------
TotalCountintegerint32------
TotalPagesintegerint32------
ItemRangearray---------
NextPageKeystring---------