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

Commerce Webstore Order Summaries

注文概要を取得します。
リソース
1/commerce/webstores/webstoreId/order-summaries
使用可能なバージョン
51.0
HTTP のメソッド
GET
GET の要求パラメーター
パラメーター名 説明 必須か省略可能 使用可能なバージョン
earliestDate String 注文概要が返す最も古い作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付以降のすべての注文が含まれます。想定される形式は ISO 8601 日付文字��� (例: 2020-02-25T18:24:31.000Z) です。 省略可能 51.0
effectiveAccount​Id String 要求が行われた取引先の ID。指定しない場合、デフォルトで、コンテキストユーザーの accountID になります。 省略可能 51.0
fields String[] UI の各品目行に表示する注文品目概要の追加項目の最大 35 個のリスト。例: fields=orderNumber, status, orderLifeCycleType
次の注文概要項目は、指定した項目に関係なく返されます。
  • createdDate
  • orderSummaryId
  • orderNumber
  • orderedDate
  • ownerId
  • status
  • totalAmount
省略可能 51.0
includeAdjustmentDetails Boolean 種別に基づいて価格調整の詳細を取得する (true) かどうかを指定します。指定しない場合は、デフォルトの false になります。 省略可能 56.0
latestDate String 注文概要が返す最新の作成日または注文日。sortOrder 値に応じて異なります。結果にはこの日付より前のすべての注文が含まれます。想定される形式は ISO 8601 日付文字列 (例: 2020-02-25T18:24:31.000Z) です。 省略可能 51.0
ownerScoped Boolean 結果の範囲が、コンテキストユーザーが所有する注文であるか (true)、コンテキストユーザーが所有している注文とコンテキストユーザーに共有された注文であるか (false) を示します。指定しない場合は、デフォルトの true になります。 省略可能 51.0
pageSize Integer ページあたりの項目数を指定します。有効な値は 1 ~ 100 です。値を指定しない場合、デフォルトサイズは 25 です。 省略可能 51.0
pageToken String base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。 省略可能 51.0
sortOrder String 注文概要の並べ替え順。値は次のとおりです。
  • CreatedDateAsc — 最も古い作成日で並べ替えます。
  • CreatedDateDesc — 最も新しい作成日で並べ替えます。
  • OrderedDateAsc — 最も古い注文日で並べ替えます。
  • OrderedDateDesc — 最も新しい注文日で並べ替えます。
指定しない場合は、デフォルトの OrderedDateDesc になります。

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

省略可能 51.0
GET のレスポンスボディ
Order Summary Collection