この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

CommerceBuyerExperience クラス

Commerce アドレスを作成、削除、または取得します。注文配送グループ、注文品目、注文配送、配送品目、および注文概要を取得します。注文品目および注文概要の調整を取得します。

名前空間

ConnectApi

CommerceBuyerExperience のメソッド

次に、CommerceBuyerExperience 用のメソッドを示します。すべてのメソッドが静的です。

getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId)

注文配送グループ概要を取得します。

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。

getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, pageSize)

注文配送グループ概要を取得します。

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 に設定されます。

getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, pageParam)

注文配送グル���プ概要のページを取得します。

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 を渡すと、最初のページが返されます。

getOrderDeliveryGroupSummaries(webstoreId, effectiveAccountId, orderSummaryId, fields)

特定の項目が含まれる注文配送グループ概要を取得します。

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 個のリスト。

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) で並べ替えられます。
null の場合、IdAsc がデフォルトの並べ替え順です。

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) で並べ替えられます。
null の場合、IdAsc がデフォルトの並べ替え順です。

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId)

注文品目概要を取得します。

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。

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, pageSize)

注文品目概要を取得します。

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 に設定されます。

getOrderItemSummaries(webstoreId, effectiveAccountId, orderSummaryId, orderDeliveryGroupSummaryId)

注文配送グループ概要の注文品目概要を取得する。

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。

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)

パラメーター

webstoreId
型: String
WebStore の ID。
effectiveAccountId
型: String
要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。
orderSummaryId
型: String
注文概要の ID。
orderDeliveryGroupSummaryId
型: String
注文配送グループ概要の ID。
pageSize
型: Integer
ページあたりの項目数を指定します。有効な値は 1 ~ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

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)

パラメーター

webstoreId
型: String
WebStore の ID。
effectiveAccountId
型: String
要求が行われた取引先の ID。null の場合、デフォルトで、コンテキストユーザーの accountID になります。
orderSummaryId
型: String
注文概要の ID。
orderDeliveryGroupSummaryId
型: String
注文配送グループ概要の ID。
fields
型: List<String>
UI の各品目行に表示する注文品目概要項目または商品項目の最大 15 個のリスト。

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) で並べ替えられます。
null の場合、IdAsc がデフォルトの並べ替え順です。

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) で並べ替えられます。
null の場合、IdAsc がデフォルトの並べ替え順です。

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)

パラメーター

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

getOrderSummaries(webstoreId, effectiveAccountId, fields)

特定の項目が含まれる注文概要を取得します。

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

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 の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。
次の注文概要項目は、指定した項目に関係なく返されます。
  • 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 の各品目行に表示する注文品目概要の追加項目の最大 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 値はサポートされていないため、エラーが発生します。

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 の各品目行に表示する注文品目概要の追加項目の最大 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) です。

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 の各品目行に表示する注文品目概要の追加項目の最大 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 になります。