| earliestDate |
String |
Oldest created or ordered date, depending on
the sortOrder value, for order
summaries to return. Results include any orders on and after this date.
Expected format is an ISO 8601 date string, for example,
2020-02-25T18:24:31.000Z. |
Optional |
51.0 |
| effectiveAccountId |
String |
ID of the account for which the request is
made. If unspecified, defaults
to the account ID for the context user. |
Optional |
51.0 |
| fields |
String[] |
List of up to 35 additional order summary fields to
display in the UI in each item row. For example, fields=orderNumber, status,
orderLifeCycleType.
These order summary fields
are returned regardless of fields specified.
- createdDate
- orderSummaryId
- orderNumber
- orderedDate
- ownerId
- status
- totalAmount
|
Optional |
51.0 |
| includeAdjustmentDetails |
Boolean |
Specifies whether to fetch price
adjustment details based on their type (true). If unspecified, defaults to false. |
Optional |
56.0 |
| latestDate |
String |
Most recent created or ordered date, depending
on the sortOrder value, for order
summaries to return. Results include any orders before this date. Expected
format is an ISO 8601 date string, for example,
2020-02-25T18:24:31.000Z. |
Optional |
51.0 |
| ownerScoped |
Boolean |
Specifies whether the results are scoped to orders
owned by the context user (true) or to
orders owned by and shared with the context user (false). If unspecified, defaults to true. |
Optional |
51.0 |
| pageSize |
Integer |
Specifies the number of items per page. Valid values are from
1 through 100. If you don’t specify a value, the default size is 25. |
Optional |
51.0 |
| pageToken |
String |
Specifies the base64 encoded page token. Page tokens
are returned as part of the response. If unspecified, the first page is
returned. |
Optional |
51.0 |
| sortOrder |
String |
Sort order for order summaries. Values are:
-
CreatedDateAsc—Sorts by the oldest
created date.
-
CreatedDateDesc—Sorts by the most
recent created date.
-
OrderedDateAsc—Sorts by the oldest
ordered date.
-
OrderedDateDesc—Sorts by the most
recent ordered date.
If unspecified, defaults to OrderedDateDesc.If you’re sorting by ordered date, make
sure the ordered date is populated on your order summary records. A null value isn’t supported and results in an
error.
|
Optional |
51.0 |
j