CommerceBuyerExperience Class

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, pageSize)

Get order item summaries.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, Integer pageSize)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
orderSummaryId: Type: String; ID of the order summary.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId)

Get order item summaries for a delivery group summary.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
orderSummaryId: Type: String; ID of the order summary.
orderDeliveryGroupSummaryId: Type: String; ID of the order delivery group summary.

Return Value

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, pageSize)

Get order item summaries for a delivery group summary.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, Integer pageSize)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
orderSummaryId: Type: String; ID of the order summary.
orderDeliveryGroupSummaryId: Type: String; ID of the order delivery group summary.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, pageParam)

Get a page of order item summaries for a delivery group summary.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, String pageParam)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
orderSummaryId: Type: String; ID of the order summary.
orderDeliveryGroupSummaryId: Type: String; ID of the order delivery group summary.
pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

Return Value

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields)

Get order item summaries for a delivery group summary with specific fields.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, List<String> fields)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
orderSummaryId: Type: String; ID of the order summary.
orderDeliveryGroupSummaryId: Type: String; ID of the order delivery group summary.
fields: Type: List<String>; List of up to 15 order item summary or product fields to display in the UI in each item row.

Return Value

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields, pageSize)

Get order item summaries for a delivery group summary with specific fields.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, List<String> fields, Integer pageSize)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
orderSummaryId: Type: String; ID of the order summary.
orderDeliveryGroupSummaryId: Type: String; ID of the order delivery group summary.
fields: Type: List<String>; List of up to 15 order item summary or product fields to display in the UI in each item row.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields, pageParam)

Get a page of order item summaries for a delivery group summary with specific fields.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, List<String> fields, String pageParam)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
orderSummaryId: Type: String; ID of the order summary.
orderDeliveryGroupSummaryId: Type: String; ID of the order delivery group summary.
fields: Type: List<String>; List of up to 15 order item summary or product fields to display in the UI in each item row.
pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

Return Value

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields, sortParam)

Get a sorted list of order item summaries for a delivery group summary with specific fields.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, List<String> fields, ConnectApi.OrderItemSummarySort sortParam)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

orderSummaryId

Type: String

ID of the order summary.

orderDeliveryGroupSummaryId

Type: String

ID of the order delivery group summary.

fields

Type: List<String>

List of up to 15 order item summary or product fields to display in the UI in each item row.

sortParam

Type: ConnectApi.OrderItemSummarySort

Sort order for order item summaries. Values are:

IdAsc—Sorts by ID in ascending alphanumeric order (A–Z, 0–9).
IdDesc—Sorts by ID in descending alphanumeric order (Z–A, 9–0).

If null, IdAsc is the default sort order.

Return Value

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields, pageSize, sortParam)

Get a sorted page of order item summaries for a delivery group summary with specific fields.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, List<String> fields, Integer pageSize, ConnectApi.OrderItemSummarySort sortParam)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

orderSummaryId

Type: String

ID of the order summary.

orderDeliveryGroupSummaryId

Type: String

ID of the order delivery group summary.

fields

Type: List<String>

List of up to 15 order item summary or product fields to display in the UI in each item row.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Type: ConnectApi.OrderItemSummarySort

Sort order for order item summaries. Values are:

IdAsc—Sorts by ID in ascending alphanumeric order (A–Z, 0–9).
IdDesc—Sorts by ID in descending alphanumeric order (Z–A, 9–0).

If null, IdAsc is the default sort order.

Return Value

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields, pageParam, pageSize, sortParam, includeAdjustmentDetails)

Get a sorted page of order item summaries for a delivery group summary with specific fields and include adjustment details.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, List<String> fields, String pageParam, Integer pageSize, ConnectApi.OrderItemSummarySort sortParam, Boolean includeAdjustmentDetails)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

orderSummaryId

Type: String

ID of the order summary.

orderDeliveryGroupSummaryId

Type: String

ID of the order delivery group summary.

fields

Type: List<String>

List of up to 15 order item summary or product fields to display in the UI in each item row.

pageParam

Type: String

Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Type: ConnectApi.OrderItemSummarySort

Sort order for order item summaries. Values are:

IdAsc—Sorts by ID in ascending alphanumeric order (A–Z, 0–9).
IdDesc—Sorts by ID in descending alphanumeric order (Z–A, 9–0).

If null, IdAsc is the default sort order.

includeAdjustmentDetails

Type: Boolean

Specifies whether to return adjustment details (true) or not (false).

Return Value

getOrderItemSummaryAdjustments(webstoreId, orderSummaryId, orderItemSummaryAdjustmentCollectionInput)

Get adjustments for order items.

API Version

53.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryAdjustmentCollection getOrderItemSummaryAdjustments(String webstoreId, String orderSummaryId, ConnectApi.OrderItemSummaryAdjustmentCollectionInput orderItemSummaryAdjustmentCollectionInput)

Parameters

webstoreId: Type: String; ID of the webstore.
orderSummaryId: Type: String; ID of the order summary.
orderItemSummaryAdjustmentCollectionInput: Type: ConnectApi.OrderItemSummaryAdjustmentCollectionInput; Collection of order item summaries to get adjustments for.

Return Value

Type: ConnectApi.OrderItemSummaryAdjustmentCollection

getOrderItemSummaryAdjustments(webstoreId, orderSummaryId, orderItemSummaryAdjustmentCollectionInput, effectiveAccountId)

Get adjustments for order items.

API Version

53.0

Requires Chatter

No

Signature

public static ConnectApi.OrderItemSummaryAdjustmentCollection getOrderItemSummaryAdjustments(String webstoreId, String orderSummaryId, ConnectApi.OrderItemSummaryAdjustmentCollectionInput orderItemSummaryAdjustmentCollectionInput, String effectiveAccountId)

Parameters

webstoreId: Type: String; ID of the webstore.
orderSummaryId: Type: String; ID of the order summary.
orderItemSummaryAdjustmentCollectionInput: Type: ConnectApi.OrderItemSummaryAdjustmentCollectionInput; Collection of order item summaries to get adjustments for.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.

Return Value

Type: ConnectApi.OrderItemSummaryAdjustmentCollection

getOrderShipmentItems(webstoreId, shipmentId)

Get order shipment items.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentItemCollection getOrderShipmentItems(String webstoreId, String shipmentId)

Parameters

webstoreId: Type: String; ID of the webstore.
shipmentId: Type: String; ID of the shipment.

Return Value

getOrderShipmentItems(webstoreId, shipmentId, effectiveAccountId)

Get order shipment items.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentItemCollection getOrderShipmentItems(String webstoreId, String shipmentId, String effectiveAccountId)

Parameters

webstoreId: Type: String; ID of the webstore.
shipmentId: Type: String; ID of the shipment.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.

Return Value

getOrderShipmentItems(webstoreId, shipmentId, effectiveAccountId, fields)

Get order shipment items with specific fields.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentItemCollection getOrderShipmentItems(String webstoreId, String shipmentId, String effectiveAccountId, List<String> fields)

Parameters

webstoreId: Type: String; ID of the webstore.
shipmentId: Type: String; ID of the shipment.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
fields: Type: List<String>; List of up to 15 additional shipment items, order item summary, and product fields to display in the UI in each item row.

Return Value

getOrderShipmentItems(webstoreId, shipmentId, effectiveAccountId, fields, pageToken, pageSize)

Get a page of order shipment items with specific fields.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentItemCollection getOrderShipmentItems(String webstoreId, String shipmentId, String effectiveAccountId, List<String> fields, String pageToken, Integer pageSize)

Parameters

webstoreId: Type: String; ID of the webstore.
shipmentId: Type: String; ID of the shipment.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
fields: Type: List<String>; List of up to 15 additional shipment items, order item summary, and product fields to display in the UI in each item row.
pageToken: Type: String; Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getOrderShipmentItems(webstoreId, shipmentId, effectiveAccountId, fields, pageToken, pageSize, sortOrder)

Get a sorted page of order shipment items.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentItemCollection getOrderShipmentItems(String webstoreId, String shipmentId, String effectiveAccountId, List<String> fields, String pageToken, Integer pageSize, ConnectApi.OrderShipmentItemSort sortOrder)

Parameters

webstoreId

Type: String

ID of the webstore.

shipmentId

Type: String

ID of the shipment.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

List of up to 15 additional shipment items, order item summary, and product fields to display in the UI in each item row.

pageToken

Type: String

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortOrder

Type: ConnectApi.OrderShipmentItemSort

Sort order for order shipment items. Values are:

IdAsc—Sorts by ID in ascending alphanumeric order (A–Z, 0–9).
IdDesc—Sorts by ID in descending alphanumeric order (Z–A, 9–0).

If unspecified, defaults to IdAsc.

Return Value

getOrderShipments(webstoreId, orderSummaryId)

Get order shipments.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentCollection getOrderShipments(String webstoreId, String orderSummaryId)

Parameters

webstoreId: Type: String; ID of the webstore.
orderSummaryId: Type: String; ID of the order summary.

Return Value

getOrderShipments(webstoreId, orderSummaryId, effectiveAccountId)

Get order shipments.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentCollection getOrderShipments(String webstoreId, String orderSummaryId, String effectiveAccountId)

Parameters

webstoreId: Type: String; ID of the webstore.
orderSummaryId: Type: String; ID of the order summary.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.

Return Value

getOrderShipments(webstoreId, orderSummaryId, effectiveAccountId, fields)

Get order shipments with specific fields.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentCollection getOrderShipments(String webstoreId, String orderSummaryId, String effectiveAccountId, List<String> fields)

Parameters

webstoreId: Type: String; ID of the webstore.
orderSummaryId: Type: String; ID of the order summary.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
fields: Type: List<String>; List of up to 15 additional shipment and order delivery method fields to display in the UI in each item row.

Return Value

getOrderShipments(webstoreId, orderSummaryId, effectiveAccountId, fields, pageSize, pageToken)

Get a page of order shipments with specific fields.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentCollection getOrderShipments(String webstoreId, String orderSummaryId, String effectiveAccountId, List<String> fields, Integer pageSize, String pageToken)

Parameters

webstoreId: Type: String; ID of the webstore.
orderSummaryId: Type: String; ID of the order summary.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.
fields: Type: List<String>; List of up to 15 additional shipment and order delivery method fields to display in the UI in each item row.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
pageToken: Type: String; Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

Return Value

getOrderShipments(webstoreId, orderSummaryId, effectiveAccountId, fields, pageSize, pageToken, sortOrder)

Get a sorted page of order shipments with specific fields.

API Version

52.0

Requires Chatter

No

Signature

public static ConnectApi.OrderShipmentCollection getOrderShipments(String webstoreId, String orderSummaryId, String effectiveAccountId, List<String> fields, Integer pageSize, String pageToken, ConnectApi.OrderShipmentSort sortOrder)

Parameters

webstoreId

Type: String

ID of the webstore.

orderSummaryId

Type: String

ID of the order summary.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

List of up to 15 additional shipment and order delivery method fields to display in the UI in each item row.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

pageToken

Type: String

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

sortOrder

Type: ConnectApi.OrderShipmentSort

Sort order for order shipments. Values are:

ExpectedDeliveryDateAsc—Sorts by the oldest expected delivery date.
ExpectedDeliveryDateDesc—Sorts by the most recent expected delivery date.
ShipmentNumberAsc—Sorts by shipment number in ascending order (0–9).
ShipmentNumberDesc—Sorts by shipment number in descending order (9–0).

If unspecified, defaults to ShipmentNumberAsc.

If you’re sorting by expected delivery date, make sure the expected delivery date is populated on your shipment records. A null value isn’t supported and results in an error.

Return Value

getOrderSummaries(webstoreId)

Get order summaries.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId)

Parameters

webstoreId: Type: String; ID of the webstore.

Return Value

Type: ConnectApi.OrderSummaryCollectionRepresentation

getOrderSummaries(webstoreId, effectiveAccountId)

Get order summaries.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId, String effectiveAccountId)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the account for which the request is made. If null, defaults to the account ID for the context user.

Return Value

Type: ConnectApi.OrderSummaryCollectionRepresentation

getOrderSummaries(webstoreId, effectiveAccountId, fields)

Get order summaries with specific fields.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId, String effectiveAccountId, List<String> fields)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

List of up to 35 additional order summary fields to display in the UI in each item row.

These order summary fields are returned regardless of fields specified.

createdDate
orderSummaryId
orderNumber
orderedDate
ownerId
status
totalAmount

Return Value

Type: ConnectApi.OrderSummaryCollectionRepresentation

getOrderSummaries(webstoreId, effectiveAccountId, fields, pageSize, pageToken)

Get a page of order summaries with specific fields.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId, String effectiveAccountId, List<String> fields, Integer pageSize, String pageToken)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

List of up to 35 additional order summary fields to display in the UI in each item row.

These order summary fields are returned regardless of fields specified.

createdDate
orderSummaryId
orderNumber
orderedDate
ownerId
status
totalAmount

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

pageToken

Type: String

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

Return Value

Type: ConnectApi.OrderSummaryCollectionRepresentation

getOrderSummaries(webstoreId, effectiveAccountId, fields, pageSize, pageToken, sortOrder)

Get a sorted page of order summaries with specific fields.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId, String effectiveAccountId, List<String> fields, Integer pageSize, String pageToken, ConnectApi.OrderSummarySortOrder sortOrder)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

List of up to 35 additional order summary fields to display in the UI in each item row.

These order summary fields are returned regardless of fields specified.

createdDate
orderSummaryId
orderNumber
orderedDate
ownerId
status
totalAmount

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

pageToken

Type: String

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

sortOrder

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.

Return Value

Type: ConnectApi.OrderSummaryCollectionRepresentation

getOrderSummaries(webstoreId, effectiveAccountId, fields, pageSize, pageToken, sortOrder, earliestDate, latestDate)

Get a sorted page of order summaries with specific fields within a specific date range.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId, String effectiveAccountId, List<String> fields, Integer pageSize, String pageToken, ConnectApi.OrderSummarySortOrder sortOrder, String earliestDate, String latestDate)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

List of up to 35 additional order summary fields to display in the UI in each item row.

These order summary fields are returned regardless of fields specified.

createdDate
orderSummaryId
orderNumber
orderedDate
ownerId
status
totalAmount

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

pageToken

Type: String

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

sortOrder

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.

earliestDate

Type: 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.

latestDate

Type: 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.

Return Value

Type: ConnectApi.OrderSummaryCollectionRepresentation

getOrderSummaries(webstoreId, effectiveAccountId, fields, pageSize, pageToken, sortOrder, earliestDate, latestDate, ownerScoped)

Get a sorted page of order summaries with specific fields within a specific date range and scoped to orders owned by the context user.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId, String effectiveAccountId, List<String> fields, Integer pageSize, String pageToken, ConnectApi.OrderSummarySortOrder sortOrder, String earliestDate, String latestDate, Boolean ownerScoped)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

List of up to 35 additional order summary fields to display in the UI in each item row.

These order summary fields are returned regardless of fields specified.

createdDate
orderSummaryId
orderNumber
orderedDate
ownerId
status
totalAmount

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

pageToken

Type: String

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

sortOrder

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.

earliestDate

Type: 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.

latestDate

Type: 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.

ownerScoped

Type: 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.

Return Value

Type: ConnectApi.OrderSummaryCollectionRepresentation

getOrderSummaries(webstoreId, effectiveAccountId, fields, pageSize, pageToken, sortOrder, earliestDate, latestDate, ownerScoped, includeAdjustmentDetails)

Get a sorted page of order summaries with specific fields within a specific date range and scoped to orders owned by the context user.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId, String effectiveAccountId, List<String> fields, Integer pageSize, String pageToken, ConnectApi.OrderSummarySortOrder sortOrder, String earliestDate, String latestDate, Boolean ownerScoped, Boolean includeAdjustmentDetails)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

List of up to 35 additional order summary fields to display in the UI in each item row.

These order summary fields are returned regardless of fields specified.

createdDate
orderSummaryId
orderNumber
orderedDate
ownerId
status
totalAmount

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

pageToken

Type: String

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

sortOrder