Connect REST API 開発者ガイド
jOrder Summaries, Preview Adjust
実際に調整を実行することなく、OrderSummary の 1 つ以上の OrderItemSummaries の価格を調整した場合に期待される結果を取得します。応答データには、提案された調整の送信によって生じる財務上の変更が含まれています。
- リソース
-
1/commerce/order-management/order-summaries/orderSummaryId/actions/adjust-item-preview - 使用可能なバージョン
- 49.0
- HTTP のメソッド
- POST
- POST のリクエストボディ
-
Adjust Order Item Summary Input
- ルート XML タグ
- <adjustOrderItemSummaryInput>
- JSON の例
-
1{ 2 "adjustItems": [{ 3 "reason": "Unknown", 4 "amount": 45, 5 "appeasementType": "AmountWithoutTax", 6 "orderItemSummaryId": "10uxx0000004EXLAA2", 7 "description": "foobar" 8 }], 9 "allocatedItemsChangeOrderType": "Disallowed" 10} - プロパティ
-
名前 型 説明 必須か省略可能 使用可能なバージョン adjustItems Adjust Item Input[] 注文品目概要への価格調整のリスト。 必須 49.0 allocatedItemsChangeOrderType String QuantityAllocated - QuantityFulfilled として定義された、現在履行中の注文品目概要の数量に使用するプロセス。値は次のとおりです。 - Disallowed — 調整分を分配する際に、履行中の数量を無視します。注文品目概要の全数量が履行中の場合、エラーが返されます。これはデフォルト値です。
- InFulfillment — 調整分を分配する際に、履行中の数量を含めます。この数量に対する調整には、別の変更注文が作成されます。
- PreFulfillment — 調整分を分配する際に、履行中の数量を含めます。これらの数量に対する調整数量は、履行前数量調整の変更注文に含められます。
省略可能 55.0 individualLineItemTaxAdjustments Boolean 税額調整ごとに複数の行を作成するか、すべての税額調整で 1 行を作成するかを指定します。デフォルト値は false です。 省略可能 59.0
- POST のレスポンスボディ
-
- HTTP 状況コードで成功が示された場合、レスポンスボディは、Adjust Order Summary Output です。それでもこのレスポンスボディが処理エラーを示す場合があります。
- HTTP 状況コードが 400 (クライアントエラー) または 500 (サーバーエラー) の範囲内にある場合、レスポンスボディは、Error with Output です。output プロパティは Adjust Order Summary Output です。enhancedErrorType プロパティの値は無視できます。