CommerceBuyerExperience クラス

API バージョン

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

orderToCartInput

型: ConnectApi.OrderToCartInput

どのカートに注文を追加する必要があるかを示す入力値。

戻り値

型: ConnectApi.OrderToCartResult

API バージョン

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

orderToCartInput

型: ConnectApi.OrderToCartInput

どのカートに注文を追加する必要があるかを示す入力値。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

戻り値

型: ConnectApi.OrderToCartResult

API バージョン

55.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryIds

型: ConnectApi.OrderSummaryAdjustmentAggregatesAsyncInput

注文概要 ID のリストを含む ConnectApi.OrderSummaryAdjustmentAggregatesAsyncInput クラス。

戻り値

型: ConnectApi.OrderSummaryAdjustmentAggregatesAsyncOutput

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

accountId

型: String

取引先の ID。

addressInput

型: ConnectApi.commerceAddressInput

作成するアドレスに関する情報。

戻り値

型: ConnectApi.CommerceAddressOutput

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

accountId

型: String

取引先の ID。

addressId

型: String

住所の ID。

戻り値

型: Void

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

accountId

型: String

取引先の ID。

戻り値

型: ConnectApi.CommerceAddressCollection

API バージョン

デフォルトのアドレスを単独で取得することも、アカウントのすべてのアドレスを取得することもできます。

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

accountId

型: String

取引先の ID。

defaultOnly

型: Boolean

デフォルトの住所のみが必要か (true)、取引先のすべての住所が必要か (false) を示します。デフォルト値は、false です。

戻り値

型: ConnectApi.CommerceAddressCollection

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

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

型: String

WebStore の ID。

accountId

型: String

取引先の ID。

defaultOnly

型: Boolean

デフォルトの住所のみが必要か (true)、取引先のすべての住所が必要か (false) を示します。デフォルト値は、false です。

addressType

型: List<String>

アドレスの種別 (Billing、Shipping など)。

fields

型: List<String>

住所のカスタム項目のリスト。

pageToken

型: String

情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

sortOrder

型: ConnectApi.CommerceAddressSort

Commerce の住所の並べ替え順。

• CreatedDateAsc — 作成日を昇順で並べ替えます。
• CreatedDateDesc — 作成日を降順で並べ替えます。
• NameAsc — 名前を昇順で並べ替えます。
• NameDesc — 名前を降順で並べ替えます。

戻り値

型: ConnectApi.CommerceAddressCollection

API バージョン

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

accountId

型: String

取引先の ID。

addressType

型: List<String>

アドレスの種別 (Billing、Shipping など)。

excludeUnsupportedCountries

型: Boolean

すべてのアドレスを取得するか (false)、または種別が「納入先」で、ストアの shipToCountries リストに含まれている国のアドレスのみを取得するか (true) を示します。デフォルト値は false です。

戻り値

型: ConnectApi.CommerceAddressCollection

API バージョン

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

accountId

型: String

取引先の ID。

defaultOnly

型: Boolean

デフォルトの住所のみが必要か (true)、取引先のすべての住所が必要か (false) を示します。デフォルト値は false です。

addressType

型: List<String>

アドレスの種別 (Billing、Shipping など)。

excludeUnsupportedCountries

型: Boolean

すべてのアドレスを取得するか (false)、または種別が「納入先」で、ストアの shipToCountries リストに含まれている国のアドレスのみを取得するか (true) を示します。デフォルト値は false です。

戻り値

型: ConnectApi.CommerceAddressCollection

API バージョン

57.0

Chatter が必要かどうか

いいえ

署名

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

型: String

WebStore の ID。

accountId

型: String

取引先の ID。

defaultOnly

型: Boolean

デフォルトの住所のみが必要か (true)、取引先のすべての住所が必要か (false) を示します。デフォルト値は false です。

addressType

型: List<String>

アドレスの種別 (Billing、Shipping など)。

excludeUnsupportedCountries

型: Boolean

すべてのアドレスを取得するか (false)、または種別が「納入先」で、ストアの shipToCountries リストに含まれている国のアドレスのみを取得するか (true) を示します。デフォルト値は false です。

fields

型: List<String>

住所のカスタム項目のリスト。

pageToken

型: String

情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

sortOrder

型: ConnectApi.CommerceAddressSort

Commerce の住所の並べ替え順。値は次のとおりです。

• CreatedDateAsc — 作成日を昇順で並べ替えます。
• CreatedDateDesc — 作成日を降順で並べ替えます。
• NameAsc — 名前を昇順で並べ替えます。
• NameDesc — 名前を降順で並べ替えます。

戻り値

型: ConnectApi.CommerceAddressCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

戻り値

型: ConnectApi.OrderDeliveryGroupSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.OrderDeliveryGroupSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

pageParam

型: String

情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

戻り値

型: ConnectApi.OrderDeliveryGroupSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文配送グループ概要項目または注文配送方法項目の最大 15 個のリスト。

戻り値

型: ConnectApi.OrderDeliveryGroupSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

pageParam

型: String

情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

fields

型: List<String>

UI の各品目行に表示する注文配送グループ概要項目または注文配送方法項目の最大 15 個のリスト。

戻り値

型: ConnectApi.OrderDeliveryGroupSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文配送グループ概要項目または注文配送方法項目の最大 15 個のリスト。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.OrderDeliveryGroupSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文配送グループ概要項目または注文配送方法項目の最大 15 個のリスト。

sortParam

型: ConnectApi.OrderDeliveryGroupSummarySort

注文配送グループ概要の並べ替え順。値は次のとおりです。

• IdAsc — ID が英数字の昇順 (A ～ Z、0 ～ 9) で並べ替えられます。
• IdDesc — ID が英数字の降順 (Z ～ A、9 ～ 0) で並べ替えられます。

null の場合、IdAsc がデフォルトの並べ替え順です。

戻り値

型: ConnectApi.OrderDeliveryGroupSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文配送グループ概要項目または注文配送方法項目の最大 15 個のリスト。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

sortParam

型: ConnectApi.OrderDeliveryGroupSummarySort

注文配送グループ概要の並べ替え順。値は次のとおりです。

• IdAsc — ID が英数字の昇順 (A ～ Z、0 ～ 9) で並べ替えられます。
• IdDesc — ID が英数字の降順 (Z ～ A、9 ～ 0) で並べ替えられます。

null の場合、IdAsc がデフォルトの並べ替え順です。

戻り値

型: ConnectApi.OrderDeliveryGroupSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

orderDeliveryGroupSummaryId

型: String

注文配送グループ概要の ID。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

orderDeliveryGroupSummaryId

型: String

注文配送グループ概要の ID。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

orderDeliveryGroupSummaryId

型: String

注文配送グループ概要の ID。

pageParam

型: String

情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

orderDeliveryGroupSummaryId

型: String

注文配送グループ概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文品目概要項目または商品項目の最大 15 個のリスト。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

orderDeliveryGroupSummaryId

型: String

注文配送グループ概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文品目概要項目または商品項目の最大 15 個のリスト。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

orderDeliveryGroupSummaryId

型: String

注文配送グループ概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文品目概要項目または商品項目の最大 15 個のリスト。

pageParam

型: String

情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

orderDeliveryGroupSummaryId

型: String

注文配送グループ概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文品目概要項目または商品項目の最大 15 個のリスト。

sortParam

型: ConnectApi.OrderItemSummarySort

注文品目概要の並べ替え順。値は次のとおりです。

• IdAsc — ID が英数字の昇順 (A ～ Z、0 ～ 9) で並べ替えられます。
• IdDesc — ID が英数字の降順 (Z ～ A、9 ～ 0) で並べ替えられます。

null の場合、IdAsc がデフォルトの並べ替え順です。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

orderDeliveryGroupSummaryId

型: String

注文配送グループ概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文品目概要項目または商品項目の最大 15 個のリスト。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

sortParam

型: ConnectApi.OrderItemSummarySort

注文品目概要の並べ替え順。値は次のとおりです。

• IdAsc — ID が英数字の昇順 (A ～ Z、0 ～ 9) で並べ替えられます。
• IdDesc — ID が英数字の降順 (Z ～ A、9 ～ 0) で並べ替えられます。

null の場合、IdAsc がデフォルトの並べ替え順です。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

56.0

Chatter が必要かどうか

いいえ

署名

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

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

orderSummaryId

型: String

注文概要の ID。

orderDeliveryGroupSummaryId

型: String

注文配送グループ概要の ID。

fields

型: List<String>

UI の各品目行に表示する注文品目概要項目または商品項目の最大 15 個のリスト。

pageParam

型: String

情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

sortParam

型: ConnectApi.OrderItemSummarySort

注文品目概要の並べ替え順。値は次のとおりです。

• IdAsc — ID が英数字の昇順 (A ～ Z、0 ～ 9) で並べ替えられます。
• IdDesc — ID が英数字の降順 (Z ～ A、9 ～ 0) で並べ替えられます。

null の場合、IdAsc がデフォルトの並べ替え順です。

includeAdjustmentDetails

型: Boolean

調整の詳細を返すか (true)、否か (false) を指定します。

戻り値

型: ConnectApi.OrderItemSummaryCollection

API バージョン

53.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

orderItemSummaryAdjustmentCollectionInput

型: ConnectApi.OrderItemSummaryAdjustmentCollectionInput

調整を取得する注文品目概要のコレクション。

戻り値

型: ConnectApi.OrderItemSummaryAdjustmentCollection

API バージョン

53.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

orderItemSummaryAdjustmentCollectionInput

型: ConnectApi.OrderItemSummaryAdjustmentCollectionInput

調整を取得する注文品目概要のコレクション。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

戻り値

型: ConnectApi.OrderItemSummaryAdjustmentCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

shipmentId

型: String

配送の ID。

戻り値

型: ConnectApi.OrderShipmentItemCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

shipmentId

型: String

配送の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

戻り値

型: ConnectApi.OrderShipmentItemCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

shipmentId

型: String

配送の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する追加出荷項目、注文品目概要項目、および商品項目の最大 15 個のリスト。

戻り値

型: ConnectApi.OrderShipmentItemCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

shipmentId

型: String

配送の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する追加出荷項目、注文品目概要項目、および商品項目の最大 15 個のリスト。

pageToken

型: String

base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.OrderShipmentItemCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

shipmentId

型: String

配送の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する追加出荷項目、注文品目概要項目、および商品項目の最大 15 個のリスト。

pageToken

型: String

base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

sortOrder

型: ConnectApi.OrderShipmentItemSort

注文配送品目の並べ替え順。値は次のとおりです。

• IdAsc — ID が英数字の昇順 (A ～ Z、0 ～ 9) で並べ替えられます。
• IdDesc — ID が英数字の降順 (Z ～ A、9 ～ 0) で並べ替えられます。

指定しない場合は、デフォルトの IdAsc になります。

戻り値

型: ConnectApi.OrderShipmentItemCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

戻り値

型: ConnectApi.OrderShipmentCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

戻り値

型: ConnectApi.OrderShipmentCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する出荷および注文品目配信方法の追加項目の最大 15 個のリスト。

戻り値

型: ConnectApi.OrderShipmentCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する出荷および注文品目配信方法の追加項目の最大 15 個のリスト。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

pageToken

型: String

base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。

戻り値

型: ConnectApi.OrderShipmentCollection

API バージョン

52.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する出荷および注文品目配信方法の追加項目の最大 15 個のリスト。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

pageToken

型: String

base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。

sortOrder

型: ConnectApi.OrderShipmentSort

注文配送の並べ替え順。値は次のとおりです。

• ExpectedDeliveryDateAsc — 最も古い予定日で並べ替えます。
• ExpectedDeliveryDateDesc — 最も新しい予定日で並べ替えます。
• ShipmentNumberAsc — 配送番号の昇順 (0 ～ 9) で並べ替えます。
• ShipmentNumberDesc — 配送番号の降順 (9 ～ 0) で並べ替えます。

指定しない場合は、デフォルトの ShipmentNumberAsc になります。

予定日で並べ替える場合は、出荷レコードに予定日が入力されていることを確認してください。null 値はサポートされていないため、エラーが発生します。

戻り値

型: ConnectApi.OrderShipmentCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId)

パラメーター

webstoreId

型: String

WebStore の ID。

戻り値

型: ConnectApi.OrderSummaryCollectionRepresentation

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

戻り値

型: ConnectApi.OrderSummaryCollectionRepresentation

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。

次の注文概要項目は、指定した項目に関係なく返されます。

• createdDate
• orderSummaryId
• orderNumber
• orderedDate
• ownerId
• status
• totalAmount

戻り値

型: ConnectApi.OrderSummaryCollectionRepresentation

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。

次の注文概要項目は、指定した項目に関係なく返されます。

• createdDate
• orderSummaryId
• orderNumber
• orderedDate
• ownerId
• status
• totalAmount

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

pageToken

型: String

base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。

戻り値

型: ConnectApi.OrderSummaryCollectionRepresentation

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。

次の注文概要項目は、指定した項目に関係なく返されます。

• createdDate
• orderSummaryId
• orderNumber
• orderedDate
• ownerId
• status
• totalAmount

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

pageToken

型: String

base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。

sortOrder

型: ConnectApi.OrderSummarySortOrder

注文概要の並べ替え順。値は次のとおりです。

• CreatedDateAsc — 最も古い作成日で並べ替えます。
• CreatedDateDesc — 最も新しい作成日で並べ替えます。
• OrderedDateAsc — 最も古い注文日で並べ替えます。
• OrderedDateDesc — 最も新しい注文日で並べ替えます。

指定しない場合は、デフォルトの OrderedDateDesc になります。

注文日で並べ替える場合は、注文概要レコードに注文日が入力されていることを確認してください。null 値はサポートされていないため、エラーが発生します。

戻り値

型: ConnectApi.OrderSummaryCollectionRepresentation

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。

次の注文概要項目は、指定した項目に関係なく返されます。

• createdDate
• orderSummaryId
• orderNumber
• orderedDate
• ownerId
• status
• totalAmount

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

pageToken

型: String

base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。

sortOrder

型: ConnectApi.OrderSummarySortOrder

注文概要の並べ替え順。値は次のとおりです。

• CreatedDateAsc — 最も古い作成日で並べ替えます。
• CreatedDateDesc — 最も新しい作成日で並べ替えます。
• OrderedDateAsc — 最も古い注文日で並べ替えます。
• OrderedDateDesc — 最も新しい注文日で並べ替えます。

指定しない場合は、デフォルトの OrderedDateDesc になります。

注文日で並べ替える場合は、注文概要レコードに注文日が入力されていることを確認してください。null 値はサポートされていないため、エラーが発生します。

earliestDate

型: String

注文概要が返す最も古い作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付以降のすべての注文が含まれます。想定される形式は ISO 8601 日付文字列 (例: 2020-02-25T18:24:31.000Z) です。

latestDate

型: String

注文概要が返す最新の作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付より前のすべての注文が含まれます。想定される形式は ISO 8601 日付文字列 (例: 2020-02-25T18:24:31.000Z) です。

戻り値

型: ConnectApi.OrderSummaryCollectionRepresentation

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。

次の注文概要項目は、指定した項目に関係なく返されます。

• createdDate
• orderSummaryId
• orderNumber
• orderedDate
• ownerId
• status
• totalAmount

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

pageToken

型: String

base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。

sortOrder

型: ConnectApi.OrderSummarySortOrder

注文概要の並べ替え順。値は次のとおりです。

• CreatedDateAsc — 最も古い作成日で並べ替えます。
• CreatedDateDesc — 最も新しい作成日で並べ替えます。
• OrderedDateAsc — 最も古い注文日で並べ替えます。
• OrderedDateDesc — 最も新しい注文日で並べ替えます。

指定しない場合は、デフォルトの OrderedDateDesc になります。

注文日で並べ替える場合は、注文概要レコードに注文日が入力されていることを確認してください。null 値はサポートされていないため、エラーが発生します。

earliestDate

型: String

注文概要が返す最も古い作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付以降のすべての注文が含まれます。想定される形式は ISO 8601 日付文字列 (例: 2020-02-25T18:24:31.000Z) です。

latestDate

型: String

注文概要が返す最新の作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付より前のすべての注文が含まれます。想定される形式は ISO 8601 日付文字列 (例: 2020-02-25T18:24:31.000Z) です。

ownerScoped

型: Boolean

結果の範囲が、コンテキストユーザーが所有する注文であるか (true)、コンテキストユーザーが所有している注文とコンテキストユーザーに共有された注文であるか (false) を示します。指定しない場合は、デフォルトの true になります。

戻り値

型: ConnectApi.OrderSummaryCollectionRepresentation

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

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

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。

次の注文概要項目は、指定した項目に関係なく返されます。

• createdDate
• orderSummaryId
• orderNumber
• orderedDate
• ownerId
• status
• totalAmount

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

pageToken

型: String

base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。

sortOrder

型: ConnectApi.OrderSummarySortOrder

注文概要の並べ替え順。値は次のとおりです。

• CreatedDateAsc — 最も古い作成日で並べ替えます。
• CreatedDateDesc — 最も新しい作成日で並べ替えます。
• OrderedDateAsc — 最も古い注文日で並べ替えます。
• OrderedDateDesc — 最も新しい注文日で並べ替えます。

指定しない場合は、デフォルトの OrderedDateDesc になります。

注文日で並べ替える場合は、注文概要レコードに注文日が入力されていることを確認してください。null 値はサポートされていないため、エラーが発生します。

earliestDate

型: String

注文概要が返す最も古い作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付以降のすべての注文が含まれます。想定される形式は ISO 8601 日付文字列 (例: 2020-02-25T18:24:31.000Z) です。

latestDate

型: String

注文概要が返す最新の作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付より前のすべての注文が含まれます。想定される形式は ISO 8601 日付文字列 (例: 2020-02-25T18:24:31.000Z) です。

ownerScoped

型: Boolean

結果の範囲が、コンテキストユーザーが所有する注文であるか (true)、コンテキストユーザーが所有している注文とコンテキストユーザーに共有された注文であるか (false) を示します。指定しない場合は、デフォルトの true になります。

戻り値

includeAdjustmentDetails

型: Boolean

種別に基づいて価格調整の詳細を取得する (true) かどうかを指定します。指定しない場合は、デフォルトの false になります。

型: ConnectApi.OrderSummaryCollectionRepresentation

API バージョン

55.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

effectiveAccount​Id

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

戻り値

型: ConnectApi.OrderSummaryRepresentation

API バージョン

55.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。

次の注文概要項目は、指定した項目に関係なく返されます。

• createdDate
• orderSummaryId
• orderNumber
• orderedDate
• ownerId
• status
• totalAmount

戻り値

型: ConnectApi.OrderSummaryRepresentation

API バージョン

55.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

fields

型: List<String>

UI の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。

次の注文概要項目は、指定した項目に関係なく返されます。

• createdDate
• orderSummaryId
• orderNumber
• orderedDate
• ownerId
• status
• totalAmount

includeAdjustmentDetails

型: Boolean

調整の詳細を返すか (true)、否か (false) を指定します。指定されていない場合、デフォルト値は false です。

戻り値

型: ConnectApi.OrderSummaryRepresentation

API バージョン

53.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

戻り値

型: ConnectApi.OrderSummaryAdjustmentCollection

API バージョン

53.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

orderSummaryId

型: String

注文概要の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。

戻り値

型: ConnectApi.OrderSummaryAdjustmentCollection

API バージョン

58.0

ゲストユーザーが使用可能

58.0

Chatter が必要かどうか

いいえ

署名

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

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。指定しない場合は、デフォルトでコンテキストユーザーの取引先 ID、または現在のストアのゲストバイヤープロファイル ID (ゲストユーザーの場合) に設定されます。

fields

型: List<String>

応答でデフォルト項目と共に返される特定の項目 (カスタム項目など) のリスト。たとえば、OrderSummary.TotalAmount, OrderItemSummary.Quantity, Product2.Description, OrderDeliveryGroupSummary.GrandTotalAmount, OrderDeliveryMethod.Carrier のようになります。

excludeLineItems

型: Boolean

応答から品目を除外するかどうかを指定します。指定されていない場合、デフォルト値は false です。

excludeDeliveryGroups

型: Boolean

応答から配送グループを除外するかどうかを指定します。指定されていない場合、デフォルト値は false です。

excludeAdjustmentAggregates

型: Boolean

注文概要に関連付けられた調整集計を除外するかどうかを指定します。調整集計には、プロモーション金額を価格、税金、合計別に示す項目が含まれています。集計は非同期で計算され、結果は注文概要に返されます。指定されていない場合、デフォルト値は false です。

excludeAdjustments

型: Boolean

注文概要に関連付けられた調整を除外するかどうかを指定します。調整には、プロモーション割引が含まれています。指定されていない場合、デフォルト値は false です。

deliveryGroupId

型: String

注文概要に関連付けられた配送グループの ID。

orderSummaryLookupInput

型: ConnectApi.OrderSummaryLookupInput

注文概要検索の入力表現。

戻り値

型: ConnectApi.OrderSummaryLookupOutput

API バージョン

58.0

ゲストユーザーが使用可能

58.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。指定しない場合は、デフォルトでコンテキストユーザーの取引先 ID、または現在のストアのゲストバイヤープロファイル ID (ゲストユーザーの場合) に設定されます。

fields

型: List<String>

応答でデフォルト項目と共に返される特定の項目 (カスタム項目など) のリスト。たとえば、OrderSummary.TotalAmount, OrderItemSummary.Quantity, Product2.Description, OrderDeliveryGroupSummary.GrandTotalAmount, OrderDeliveryMethod.Carrier のようになります。

orderSummaryLookupInput

型: ConnectApi.OrderSummaryLookupInput

注文概要検索の入力表現。

戻り値

型: ConnectApi.OrderSummaryLookupOutput

API バージョン

58.0

ゲストユーザーが使用可能

58.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。指定しない場合は、デフォルトでコンテキストユーザーの取引先 ID、または現在のストアのゲストバイヤープロファイル ID (ゲストユーザーの場合) に設定されます。

orderSummaryLookupInput

型: ConnectApi.OrderSummaryLookupInput

注文概要検索の入力表現。

戻り値

型: ConnectApi.OrderSummaryLookupOutput

API バージョン

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

accountId

型: String

取引先の ID。

addressId

型: String

住所の ID。

addressInput

型: ConnectApi.commerceAddressInput

更新するアドレス項目に関する情報。

戻り値

型: ConnectApi.CommerceAddressOutput