CommerceBuyerExperience クラス
名前空間
CommerceBuyerExperience のメソッド
getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId)
パラメータ
getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, pageSize)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, Integer pageSize)
パラメータ
getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, pageParam)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String pageParam)
パラメータ
getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, fields)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderDeliveryGroupSummaryCollection getOrderDeliveryGroupSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, List<String> fields)
パラメータ
getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, pageParam, fields)
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 個のリスト。
getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, fields, pageSize)
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 に設定されます。
getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, fields, sortParam)
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) で並び替えられます。
getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, fields, pageSize, sortParam)
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) で並び替えられます。
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId)
パラメータ
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, pageSize)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, Integer pageSize)
パラメータ
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId)
パラメータ
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, pageSize)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, Integer pageSize)
パラメータ
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, pageParam)
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 を渡すと、最初のページが返されます。
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderItemSummaryCollection getOrderItemSummaries(String webstoreId, String effectiveAccountId, String orderSummaryId, String orderDeliveryGroupSummaryId, List<String> fields)
パラメータ
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields, pageSize)
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 に設定されます。
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields, pageParam)
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 を渡すと、最初のページが返されます。
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields, sortParam)
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) で並び替えられます。
getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId, fields, pageSize, sortParam)
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) で並び替えられます。
getOrderSummaries(webstoreId)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId)
パラメータ
- webstoreId
- 型: String
- WebStore の ID。
getOrderSummaries(webstoreId, effectiveAccountId)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId, String effectiveAccountId)
パラメータ
getOrderSummaries(webstoreId, effectiveAccountId, fields)
API バージョン
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.OrderSummaryCollectionRepresentation getOrderSummaries(String webstoreId, String effectiveAccountId, List<String> fields)
パラメータ
getOrderSummaries(webstoreId, effectiveAccountId, fields, pageSize, pageToken)
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 の各品目行に表示する注文品目概要の追加項目の最大 15 個のリスト。次の注文概要項目は、指定した項目に関係なく返されます。
- createdDate
- orderSummaryId
- orderNumber
- orderedDate
- ownerId
- status
- totalAmount
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ~ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- pageToken
- 型: String
- base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。
getOrderSummaries(webstoreId, effectiveAccountId, fields, pageSize, pageToken, sortOrder)
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 の各品目行に表示する注文品目概要の追加項目の最大 15 個のリスト。次の注文概要項目は、指定した項目に関係なく返されます。
- createdDate
- orderSummaryId
- orderNumber
- orderedDate
- ownerId
- status
- totalAmount
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ~ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- pageToken
- 型: String
- base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。
- sortOrder
- 型: ConnectApi.OrderSummarySortOrder
- 注文概要の並び替え順。値は次のとおりです。
- CreatedDateAsc — 最も古い作成日で並び替えます。
- CreatedDateDesc — 最も新しい作成日で並び替えます。
- OrderedDateAsc — 最も古い注文日で並び替えます。
- OrderedDateDesc — 最も新しい注文日で並び替えます。
注文日で並び替える場合は、注文概要レコードに注文日が入力されていることを確認してください。null 値はサポートされていないため、エラーが発生します。
getOrderSummaries(webstoreId, effectiveAccountId, fields, pageSize, pageToken, sortOrder, earliestDate, latestDate)
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 の各品目行に表示する注文品目概要の追加項目の最大 15 個のリスト。次の注文概要項目は、指定した項目に関係なく返されます。
- createdDate
- orderSummaryId
- orderNumber
- orderedDate
- ownerId
- status
- totalAmount
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ~ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- pageToken
- 型: String
- base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。
- sortOrder
- 型: ConnectApi.OrderSummarySortOrder
- 注文概要の並び替え順。値は次のとおりです。
- CreatedDateAsc — 最も古い作成日で並び替えます。
- CreatedDateDesc — 最も新しい作成日で並び替えます。
- OrderedDateAsc — 最も古い注文日で並び替えます。
- OrderedDateDesc — 最も新しい注文日で並び替えます。
注文日で並び替える場合は、注文概要レコードに注文日が入力されていることを確認してください。null 値はサポートされていないため、エラーが発生します。
- earliestDate
- 型: String
- 注文概要が返す最も古い作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付以降のすべての注文が含まれます。想定される形式は ISO 8601 日付文字列 (例: 2020-02-25T18:24:31.000Z) です。
- latestDate
- 型: String
- 注文概要が返す最新の作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付より前のすべての注文が含まれます。想定される形式は ISO 8601 日付文字列 (例: 2020-02-25T18:24:31.000Z) です。
getOrderSummaries(webstoreId, effectiveAccountId, fields, pageSize, pageToken, sortOrder, earliestDate, latestDate, ownerScoped)
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 の各品目行に表示する注文品目概要の追加項目の最大 15 個のリスト。次の注文概要項目は、指定した項目に関係なく返されます。
- createdDate
- orderSummaryId
- orderNumber
- orderedDate
- ownerId
- status
- totalAmount
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ~ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- pageToken
- 型: String
- base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。
- sortOrder
- 型: ConnectApi.OrderSummarySortOrder
- 注文概要の並び替え順。値は次のとおりです。
- CreatedDateAsc — 最も古い作成日で並び替えます。
- CreatedDateDesc — 最も新しい作成日で並び替えます。
- OrderedDateAsc — 最も古い注文日で並び替えます。
- 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 になります。