CommerceBuyerExperience Class

API Version

57.0

Requires Chatter

No

Signature

public static ConnectApi.OrderToCartResult addOrderToCart(String webstoreId, String orderSummaryId, ConnectApi.OrderToCartInput orderToCartInput)

Parameters

webstoreId

Type: String

ID of the webstore.

orderSummaryId

Type: String

ID of the order summary.

orderToCartInput

Type: ConnectApi.OrderToCartInput

Input value indicating which cart the order should be added to.

Return Value

Type: ConnectApi.OrderToCartResult

API Version

57.0

Requires Chatter

No

Signature

public static ConnectApi.OrderToCartResult addOrderToCart(String webstoreId, String orderSummaryId, ConnectApi.OrderToCartInput orderToCartInput, String effectiveAccountId)

Parameters

webstoreId

Type: String

ID of the webstore.

orderSummaryId

Type: String

ID of the order summary.

orderToCartInput

Type: ConnectApi.OrderToCartInput

Input value indicating which cart the order should be added to.

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.OrderToCartResult

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryAdjustmentAggregatesAsyncOutput calculateAdjustmentAggregates(String webstoreId, ConnectApi.OrderSummaryAdjustmentAggregatesAsyncInput orderSummaryIds)

Parameters

webstoreId

Type: String

ID of the webstore.

orderSummaryIds

Type: ConnectApi.OrderSummaryAdjustmentAggregatesAsyncInput

A ConnectApi.OrderSummaryAdjustmentAggregatesAsyncInput class with a list of order summary IDs.

Return Value

Type: ConnectApi.OrderSummaryAdjustmentAggregatesAsyncOutput

API Version

54.0

Requires Chatter

No

Signature

public static ConnectApi.CommerceAddressOutput createCommerceAccountAddress(String webstoreId, String accountId, ConnectApi.commerceAddressInput addressInput)

Parameters

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

addressInput

Type: ConnectApi.commerceAddressInput

Information about the address you want to create.

Return Value

Type: ConnectApi.CommerceAddressOutput

API Version

54.0

Requires Chatter

No

Signature

public static Void deleteCommerceAccountAddress(String webstoreId, String accountId, String addressId)

Parameters

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

addressId

Type: String

ID of the address.

Return Value

Type: Void

API Version

54.0

Requires Chatter

No

Signature

public static ConnectApi.CommerceAddressCollection getCommerceAccountAddress(String webstoreId, String accountId)

Parameters

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

Return Value

Type: ConnectApi.CommerceAddressCollection

API Version

You can get the default address by itself, or you can get all of the addresses for the account.

54.0

Requires Chatter

No

Signature

public static ConnectApi.CommerceAddressCollection getCommerceAccountAddress(String webstoreId, String accountId, Boolean defaultOnly)

Parameters

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

defaultOnly

Type: Boolean

Indicate if you only want the default address (true) or all addresses for the account (false). The default value is false.

Return Value

Type: ConnectApi.CommerceAddressCollection

API Version

54.0

Requires Chatter

No

Signature

public static ConnectApi.CommerceAddressCollection getCommerceAccountAddress(String webstoreId, String accountId, Boolean defaultOnly, List<String> addressType, List<String> fields, String pageToken, Integer pageSize, ConnectApi.CommerceAddressSort sortOrder)

Parameters

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

defaultOnly

Type: Boolean

Indicate if you want only the default address (true) or all addresses for the account (false). The default value is false.

addressType

Type: List<String>

Type of address, for example, Billing or Shipping.

fields

Type: List<String>

A list of custom fields for the address.

pageToken

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.

sortOrder

Type: ConnectApi.CommerceAddressSort

Sort order for Commerce addresses.

• CreatedDateAsc—Sort in ascending order of created date.
• CreatedDateDesc—Sort in descending order of created date.
• NameAsc—Sort in ascending order of name.
• NameDesc—Sort in descending order of name.

Return Value

Type: ConnectApi.CommerceAddressCollection

API Version

57.0

Requires Chatter

No

Signature

public static ConnectApi.CommerceAddressCollection getCommerceAccountAddress(String webstoreId, String accountId, List<String> addressType, Boolean excludeUnsupportedCountries)

Parameters

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

addressType

Type: List<String>

Type of address, for example, Billing or Shipping.

excludeUnsupportedCountries

Type: Boolean

Indicate if you want to retrieve all addresses (false) or only addresses of type Shipping that are in countries included in the store’s shipToCountries list (true). The default value is false.

Return Value

Type: ConnectApi.CommerceAddressCollection

API Version

57.0

Requires Chatter

No

Signature

public static ConnectApi.CommerceAddressCollection getCommerceAccountAddress(String webstoreId, String accountId, Boolean defaultOnly, List<String> addressType, Boolean excludeUnsupportedCountries)

Parameters

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

defaultOnly

Type: Boolean

Indicate if you want only the default address (true) or all addresses for the account (false). The default value is false.

addressType

Type: List<String>

Type of address, for example, Billing or Shipping.

excludeUnsupportedCountries

Type: Boolean

Indicate if you want to retrieve all addresses (false) or only addresses of type Shipping that are in countries included in the store’s shipToCountries list (true). The default value is false.

Return Value

Type: ConnectApi.CommerceAddressCollection

API Version

57.0

Requires Chatter

No

Signature

public static ConnectApi.CommerceAddressCollection getCommerceAccountAddress(String webstoreId, String accountId, Boolean defaultOnly, List<String> addressType, Boolean excludeUnsupportedCountries, List<String> fields, String pageToken, Integer pageSize, ConnectApi.CommerceAddressSort sortOrder)

Parameters

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

defaultOnly

Type: Boolean

Indicate if you want only the default address (true) or all addresses for the account (false). The default value is false.

addressType

Type: List<String>

Type of address, for example, Billing or Shipping.

excludeUnsupportedCountries

Type: Boolean

Indicate if you want to retrieve all addresses (false) or only addresses of type Shipping that are in countries included in the store’s shipToCountries list (true). The default value is false.

fields

Type: List<String>

A list of custom fields for the address.

pageToken

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.

sortOrder

Type: ConnectApi.CommerceAddressSort

Sort order for Commerce addresses. Values are:

• CreatedDateAsc—Sort in ascending order of created date.
• CreatedDateDesc—Sort in descending order of created date.
• NameAsc—Sort in ascending order of name.
• NameDesc—Sort in descending order of name.

Return Value

Type: ConnectApi.CommerceAddressCollection

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

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

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

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

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

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

Type: ConnectApi.OrderItemSummaryCollection

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

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

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

Type: ConnectApi.OrderShipmentItemCollection

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

Type: ConnectApi.OrderShipmentItemCollection

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

Type: ConnectApi.OrderShipmentItemCollection

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

Type: ConnectApi.OrderShipmentItemCollection

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

Type: ConnectApi.OrderShipmentItemCollection

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

Type: ConnectApi.OrderShipmentCollection

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

Type: ConnectApi.OrderShipmentCollection

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

Type: ConnectApi.OrderShipmentCollection

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

Type: ConnectApi.OrderShipmentCollection

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

Type: ConnectApi.OrderShipmentCollection

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

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

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

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

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

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

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

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

includeAdjustmentDetails

Type: Boolean

Specifies whether to fetch price adjustment details based on their type (true). If unspecified, defaults to false.

Type: ConnectApi.OrderSummaryCollectionRepresentation

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryRepresentation getOrderSummary(String webstoreId, String orderSummaryId, String effectiveAccountId)

Parameters

webstoreId

Type: String

ID of the webstore.

orderSummaryId

Type: String

ID of the order summary.

effectiveAccount​Id

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.OrderSummaryRepresentation

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryRepresentation getOrderSummary(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 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.OrderSummaryRepresentation

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryRepresentation getOrderSummary(String webstoreId, String orderSummaryId, String effectiveAccountId, List<String> fields, Boolean includeAdjustmentDetails)

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

includeAdjustmentDetails

Type: Boolean

Specifies whether to return adjustment details (true) or not (false). If unspecified, the default value is false.

Return Value

Type: ConnectApi.OrderSummaryRepresentation

API Version

53.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryAdjustmentCollection getOrderSummaryAdjustments(String webstoreId, String orderSummaryId)

Parameters

webstoreId

Type: String

ID of the webstore.

orderSummaryId

Type: String

ID of the order summary.

Return Value

Type: ConnectApi.OrderSummaryAdjustmentCollection

API Version

53.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryAdjustmentCollection getOrderSummaryAdjustments(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

Type: ConnectApi.OrderSummaryAdjustmentCollection

API Version

58.0

Available to Guest Users

58.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryLookupOutput lookupOrderSummary(String webstoreId, String effectiveAccountId, List<String> fields, Boolean excludeLineItems, Boolean excludeDeliveryGroups, Boolean excludeAdjustmentAggregates, Boolean excludeAdjustments, String deliveryGroupId, ConnectApi.OrderSummaryLookupInput orderSummaryLookupInput)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user or, for guest users, the guest buyer profile ID of the current store.

fields

Type: List<String>

List of specific fields, including custom fields, to return in the response along with default fields. For example, OrderSummary.TotalAmount, OrderItemSummary.Quantity, Product2.Description, OrderDeliveryGroupSummary.GrandTotalAmount, OrderDeliveryMethod.Carrier.

excludeLineItems

Type: Boolean

Specifies whether to exclude line items from the response. If unspecified, the default value is false.

excludeDeliveryGroups

Type: Boolean

Specifies whether to exclude delivery groups from the response. If unspecified, the default value is false.

excludeAdjustmentAggregates

Type: Boolean

Specifies whether to exclude adjustment aggregates associated with an order summary. Adjustment aggregates include fields detailing promotional amounts by price, tax, and total. Aggregates are calculated asynchronously and results returned to the order summary. If unspecified, the default value is false.

excludeAdjustments

Type: Boolean

Specifies whether to exclude adjustments associated with an order summary. Adjustments include promotional discounts. If unspecified, the default value is false.

deliveryGroupId

Type: String

ID of the delivery group associated with the order summary.

orderSummaryLookupInput

Type: ConnectApi.OrderSummaryLookupInput

Order summary lookup input representation.

Return Value

Type: ConnectApi.OrderSummaryLookupOutput

API Version

58.0

Available to Guest Users

58.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryLookupOutput lookupOrderSummary(String webstoreId, String effectiveAccountId, List<String> fields, ConnectApi.OrderSummaryLookupInput orderSummaryLookupInput)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user or, for guest users, the guest buyer profile ID of the current store.

fields

Type: List<String>

List of specific fields, including custom fields, to return in the response along with default fields. For example, OrderSummary.TotalAmount, OrderItemSummary.Quantity, Product2.Description, OrderDeliveryGroupSummary.GrandTotalAmount, OrderDeliveryMethod.Carrier.

orderSummaryLookupInput

Type: ConnectApi.OrderSummaryLookupInput

Order summary lookup input representation.

Return Value

Type: ConnectApi.OrderSummaryLookupOutput

API Version

58.0

Available to Guest Users

58.0

Requires Chatter

No

Signature

public static ConnectApi.OrderSummaryLookupOutput lookupOrderSummary(String webstoreId, String effectiveAccountId, ConnectApi.OrderSummaryLookupInput orderSummaryLookupInput)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user or, for guest users, the guest buyer profile ID of the current store.

orderSummaryLookupInput

Type: ConnectApi.OrderSummaryLookupInput

Order summary lookup input representation.

Return Value

Type: ConnectApi.OrderSummaryLookupOutput

API Version

54.0

Requires Chatter

No

Signature

public static ConnectApi.CommerceAddressOutput updateCommerceAccountAddress(String webstoreId, String accountId, String addressId, ConnectApi.commerceAddressInput addressInput)

Parameters

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

addressId

Type: String

ID of the address.

addressInput

Type: ConnectApi.commerceAddressInput

Information about the address fields you want to update.

Return Value

Type: ConnectApi.CommerceAddressOutput