List order eligible approvers

Request

Returns all Users who can approve or decline this order (but have not done so).

Security

OAuth2(Required scopes: FullAccessOrderAdminShopperOrderReader)

Path

directionstring(OrderDirection)required

Direction of the order, from the current user's perspective.

Enum:"Incoming""Outgoing""All"

orderIDstringrequired

ID of the order.

Query

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""Username""LastName""FirstName""Email"

sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"LastName""FirstName""Username""ID""Email""DateCreated""LastActive""PasswordLastSetDate""!LastName""!FirstName"

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1

pageSizeinteger, <= 100

Number of results to return per page.

Default:20

filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/orders/{direction}/{orderID}/eligibleapprovers?search=string&searchOn=ID&sortBy=LastName&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns all Users who can approve or decline this order (but have not done so).

Bodyapplication/json

ItemsArray of objects(User)

Example:

[
  {
    "FailedLoginAttempts": 0,
    "ID": "",
    "CompanyID": "",
    "Username": "",
    "Password": "",
    "FirstName": "",
    "LastName": "",
    "Email": "",
    "Phone": "",
    "TermsAccepted": "2018-01-01T00:00:00-06:00",
    "Active": false,
    "xp": {},
    "AvailableRoles": [ … ],
    "Locale": { … },
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "LastActive": "2018-01-01T00:00:00-06:00",
    "PasswordLastSetDate": "2018-01-01T00:00:00-06:00"
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}