CommerceBuyerExperience Class

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId)

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.

Return Value

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(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

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, 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.

pageParam

Type: String

Specifies the page token to be used 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

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, 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.

fields

Type: List<String>

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

Return Value

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String pageParam, 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.

pageParam

Type: String

Specifies the page token to be used 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.

fields

Type: List<String>

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

Return Value

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, 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.

fields

Type: List<String>

List of up to 15 order delivery group summary or 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.

Return Value

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, List<String> fields, ConnectApi.OrderDeliveryGroupSummarySort 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.

fields

Type: List<String>

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

sortParam

Type: ConnectApi.OrderDeliveryGroupSummarySort

Sort order for order delivery group 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

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, List<String> fields, Integer pageSize, ConnectApi.OrderDeliveryGroupSummarySort 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.

fields

Type: List<String>

List of up to 15 order delivery group summary or 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.

sortParam

Type: ConnectApi.OrderDeliveryGroupSummarySort

Sort order for order delivery group 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

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

API Version

51.0

Requires Chatter

No

Signature

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

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.

Return Value

Type: ConnectApi.OrderItemSummaryCollection

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

Type: ConnectApi.OrderItemSummaryCollection

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

Type: ConnectApi.OrderItemSummaryCollection

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

Type: ConnectApi.OrderItemSummaryCollection

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 be used 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

Type: ConnectApi.OrderItemSummaryCollection

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

Type: ConnectApi.OrderItemSummaryCollection

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

Type: ConnectApi.OrderItemSummaryCollection

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 be used 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

Type: ConnectApi.OrderItemSummaryCollection

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

Type: ConnectApi.OrderItemSummaryCollection

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

Type: ConnectApi.OrderItemSummaryCollection

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

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

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 15 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

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 15 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

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 15 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

Type: ConnectApi.OrderSummarySortOrder

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

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 15 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

Type: ConnectApi.OrderSummarySortOrder

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

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 15 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

Type: ConnectApi.OrderSummarySortOrder

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