CommerceBuyerExperience Class

Create, delete, or get commerce addresses. Get order delivery group, order item, order shipments, shipment items, and order summaries. Get adjustments for order items and order summaries.

ConnectApi

These methods are for CommerceBuyerExperience. All methods are static.

Add an order to a cart using a webstore order summary.

57.0

No

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

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.

Type: ConnectApi.OrderToCartResult

Add an order to a cart for a specific account using a webstore order summary.

57.0

No

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

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.

Type: ConnectApi.OrderToCartResult

Submit a job to calculate adjustment aggregates for a list of order summary IDs.

55.0

No

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

webstoreId

Type: String

ID of the webstore.

orderSummaryIds

Type: ConnectApi.OrderSummaryAdjustmentAggregatesAsyncInput

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

Type: ConnectApi.OrderSummaryAdjustmentAggregatesAsyncOutput

Create a Commerce account address for a webstore account.

54.0

No

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

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.

Type: ConnectApi.CommerceAddressOutput

Delete a Commerce account address for a webstore.

54.0

No

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

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

addressId

Type: String

ID of the address.

Type: Void

Get a Commerce account address for a webstore.

54.0

No

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

webstoreId

Type: String

ID of the webstore.

accountId

Type: String

ID of the account.

Type: ConnectApi.CommerceAddressCollection

Get Commerce account addresses for a webstore and account.

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

54.0

No

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

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.

Type: ConnectApi.CommerceAddressCollection

Get Commerce account addresses for a webstore and account.

54.0

No

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

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.

Type: ConnectApi.CommerceAddressCollection

Get Commerce account addresses for a webstore and account.

57.0

No

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

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.

Type: ConnectApi.CommerceAddressCollection

Get Commerce account addresses for a webstore and account.

57.0

No

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

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.

Type: ConnectApi.CommerceAddressCollection

Get Commerce account addresses for a webstore and account.

57.0

No

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)

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.

Type: ConnectApi.CommerceAddressCollection

Get order delivery group summaries.

51.0

No

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

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.

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

Get order delivery group summaries.

51.0

No

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

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.

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

Get a page of order delivery group summaries.

51.0

No

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

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.

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

Get order delivery group summaries with specific fields.

51.0

No

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, List<String> fields)

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. For example, fields=OrderDelivery​GroupSummary.DeliveryAddress, OrderDeliveryMethod.Name.

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

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

51.0

No

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String pageParam, List<String> fields)

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. For example, fields=OrderDelivery​GroupSummary.DeliveryAddress, OrderDeliveryMethod.Name.

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

Get order delivery group summaries with specific fields.

51.0

No

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, List<String> fields, Integer pageSize)

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. For example, fields=OrderDelivery​GroupSummary.DeliveryAddress, OrderDeliveryMethod.Name.

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.

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

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

51.0

No

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, List<String> fields, ConnectApi.OrderDeliveryGroupSummarySort sortParam)

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. For example, fields=OrderDelivery​GroupSummary.DeliveryAddress, OrderDeliveryMethod.Name.

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.

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

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

51.0

No

public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, List<String> fields, Integer pageSize, ConnectApi.OrderDeliveryGroupSummarySort sortParam)

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. For example, fields=OrderDelivery​GroupSummary.DeliveryAddress, OrderDeliveryMethod.Name.

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.

Type: ConnectApi.OrderDeliveryGroupSummaryCollection

Get order item summaries.

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

Get order item summaries.

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

Get order item summaries for a delivery group summary.

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

Get order item summaries for a delivery group summary.

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

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

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

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

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

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

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

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

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

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

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

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

51.0

No

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

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.

Type: ConnectApi.OrderItemSummaryCollection

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

56.0

No

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)

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

Type: ConnectApi.OrderItemSummaryCollection

Get adjustments for order items.

53.0

No

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

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.

Type: ConnectApi.OrderItemSummaryAdjustmentCollection

Get adjustments for order items.

53.0

No

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

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.

Type: ConnectApi.OrderItemSummaryAdjustmentCollection

Get order shipment items.

52.0

No

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

webstoreId

Type: String

ID of the webstore.

shipmentId

Type: String

ID of the shipment.

Type: ConnectApi.OrderShipmentItemCollection

Get order shipment items.

52.0

No

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

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.

Type: ConnectApi.OrderShipmentItemCollection

Get order shipment items with specific fields.

52.0

No

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

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.

Type: ConnectApi.OrderShipmentItemCollection

Get a page of order shipment items with specific fields.

52.0

No

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

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.

Type: ConnectApi.OrderShipmentItemCollection

Get a sorted page of order shipment items.

52.0

No

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

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.

Type: ConnectApi.OrderShipmentItemCollection

Get order shipments.

52.0

No

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

webstoreId

Type: String

ID of the webstore.

orderSummaryId

Type: String

ID of the order summary.

Type: ConnectApi.OrderShipmentCollection

Get order shipments.

52.0

No

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

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.

Type: ConnectApi.OrderShipmentCollection

Get order shipments with specific fields.

52.0

No

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

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.

Type: ConnectApi.OrderShipmentCollection

Get a page of order shipments with specific fields.

52.0

No

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

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.

Type: ConnectApi.OrderShipmentCollection

Get a sorted page of order shipments with specific fields.

52.0

No

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

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.

Type: ConnectApi.OrderShipmentCollection

Get order summaries.

51.0

No

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId)

webstoreId

Type: String

ID of the webstore.

Type: ConnectApi.OrderSummaryCollectionRepresentation

Get order summaries.

51.0

No

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

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.

Type: ConnectApi.OrderSummaryCollectionRepresentation

Get order summaries with specific fields.

51.0

No

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

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

Type: ConnectApi.OrderSummaryCollectionRepresentation

Get a page of order summaries with specific fields.

51.0

No

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

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.

Type: ConnectApi.OrderSummaryCollectionRepresentation

Get a sorted page of order summaries with specific fields.

51.0

No

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

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.

Type: ConnectApi.OrderSummaryCollectionRepresentation

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

51.0

No

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

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

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.

Type: ConnectApi.OrderSummaryCollectionRepresentation

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

51.0

No

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)

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

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.

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.

Type: ConnectApi.OrderSummaryCollectionRepresentation

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

51.0

No

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)

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

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.

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.

includeAdjustmentDetails

Type: Boolean

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

Type: ConnectApi.OrderSummaryCollectionRepresentation

Get an order summary.

55.0

No

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

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.

Type: ConnectApi.OrderSummaryRepresentation

Get an order summary with fields.

55.0

No

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

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

Type: ConnectApi.OrderSummaryRepresentation

Get an order summary with fields and include adjustment details.

55.0

No

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

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.

Type: ConnectApi.OrderSummaryRepresentation

Get adjustments for an order summary.

53.0

No

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

webstoreId

Type: String

ID of the webstore.

orderSummaryId

Type: String

ID of the order summary.

Type: ConnectApi.OrderSummaryAdjustmentCollection

Get adjustments for an order summary.

53.0

No

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

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.

Type: ConnectApi.OrderSummaryAdjustmentCollection

Look up details about an order summary for a guest shopper or a registered buyer using the effective account ID, requested fields, line items, delivery groups, adjustments aggregates, and adjustments.

This API is available as a developer preview. It isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Don’t implement functionality developed with these commands or tools.

58.0

58.0

No

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)

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.

Type: ConnectApi.OrderSummaryLookupOutput

Look up details about an order summary for a guest shopper or a registered buyer using the effective account ID and requested fields.

This API is available as a developer preview. It isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Don’t implement functionality developed with these commands or tools.

58.0

58.0

No

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

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.

Type: ConnectApi.OrderSummaryLookupOutput

Look up details about an order summary for a guest shopper or a registered buyer using the effective account ID.

This API is available as a developer preview. It isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Don’t implement functionality developed with these commands or tools.

58.0

58.0

No

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

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.

Type: ConnectApi.OrderSummaryLookupOutput

Update a Commerce account address for a webstore.

54.0

No

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

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.

Type: ConnectApi.CommerceAddressOutput