Connect REST API 開発者ガイド
jOrder Summaries, Submit Adjust
- リソース
-
1/commerce/order-management/order-summaries/orderSummaryId/actions/adjust-item-submit - 使用可能なバージョン
- 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 プロパティの値は無視できます。
- 使用方法
- 価格調整が OrderItemSummary に適用される際に、その数量は次の 3 つのグループで考慮されます。
- 履行前
- QuantityAvailableToFulfill。これは QuantityOrdered - QuantityCanceled - QuantityAllocated と等価です。
- 履行中
- QuantityAllocated - QuantityFulfilled
- 履行後
- QuantityAvailableToReturn。これは QuantityFulfilled - QuantityReturnInitiated と等価です。
- これらのグループには、3 種類の方法で調整を適用できます。これは、allocatedItemsChangeOrderType 入力プロパティで制御します。
- 調整量を履行前と履行後の数量に均等に配分します。履行中の数量は無視されます。履行前数量の調整に関する変更注文が 1 件と、履行後数量の調整に関する変更注文が 1 件作成されます。
- 調整量を履行前、履行中、および履行後の数量に均等に配分します。履行前数量および履行中数量の両方の調整に関する変更注文が 1 件と、履行後数量の調整に関する変更注文が 1 件作成されます。
- 調整量を履行前、履行中、および履行後の数量に均等に配分します。履行前数量の調整に関する変更注文が 1 件、履行中数量の調整に関する変更注文が 1 件、および履行後数量の調整に関する変更注文が 1 件作成されます。
- 価格調整を送信したら、必要に応じて返金を処理します。
- 支払が未取得の OrderItemSummaries にのみ割引が適用される場合、返金は必要ありません。この状況は通常、米国の履行されていない OrderItemSummaries の場合に当てはまります。
- OrderItemSummaries が、履行されておらず、支払が取得済みの状況で割引が適用される場合は、返金を処理します。この場合は、レスポンスボディの totalExcessFundsAmount を Order Summaries, Ensure Refunds Async リソースに渡します。
- 履行済み OrderItemSummaries に割引が適用される場合は、返金を処理します。レスポンスボディの postFulfillmentChangeOrderId を Order Summaries, Create Credit Memo リソースに渡してから、CreditMemo を Order Summaries, Ensure Refunds Async リソースに渡します。
- 支払が取得済みの状況で、OrderItemSummaries が履行済みと未履行の両方に割引が適用される場合は、両方の返金を処理します。レスポンスボディの postFulfillmentChangeOrderId を Order Summaries, Create Credit Memo リソースに渡してから、レスポンスボディのクレジットメモおよび totalExcessFundsAmount を Order Summaries, Ensure Refunds Async リソースに渡します。