Apex 開発者ガイド
jOrderSummary クラス
名前空間
OrderSummary のメソッド
adjustPreview(orderSummaryId, adjustInput)
API バージョン
49.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.AdjustOrderSummaryOutputRepresentation adjustPreview(String orderSummaryId, ConnectApi.AdjustOrderItemSummaryInputRepresentation adjustInput)
パラメータ
- orderSummaryId
- 型: String
- OrderSummary の ID。
- adjustInput
- 型: ConnectApi.AdjustOrderItemSummaryInputRepresentation
- OrderItemSummaries への価格調整であり、まとまって注文に対する 1 つの価格調整を構成します。履行プロセス中の品目を調整するオプションを使用できます。
使用方法
価格調整が OrderItemSummary に適用される際に、その数量は次の 3 つのグループで考慮されます。
- 履行前
- QuantityAvailableToFulfill。これは QuantityOrdered - QuantityCanceled - QuantityAllocated と等価です。
- 履行中
- QuantityAllocated - QuantityFulfilled
- 履行後
- QuantityAvailableToReturn。これは QuantityFulfilled - QuantityReturnInitiated と等価です。
これらのグループには、3 種類の方法で調整を適用できます。これは、allocatedItemsChangeOrderType 入力プロパティで制御します。
- 調整量を履行前と履行後の数量に均等に配分します。履行中の数量は無視されます。調整を送信すると、履行前数量の調整に関する変更注文が 1 件と、履行後数量の調整に関する変更注文が 1 件作成されます。
- 調整量を履行前、履行中、および履行後の数量に均等に配分します。調整を送信すると、履行前数量および履行中数量の両方の調整に関する変更注文が 1 件と、履行後数量の調整に関する変更注文が 1 件作成されます。
- 調整量を履行前、履行中、および履行後の数量に均等に配分します。調整を送信すると、履行前数量の調整に関する変更注文が 1 件、履行中数量の調整に関する変更注文が 1 件、および履行後数量の調整に関する変更注文が 1 件作成されます。
adjustSubmit(orderSummaryId, adjustInput)
API バージョン
49.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.AdjustOrderSummaryOutputRepresentation adjustSubmit(String orderSummaryId, ConnectApi.AdjustOrderItemSummaryInputRepresentation adjustInput)
パラメータ
- orderSummaryId
- 型: String
- OrderSummary の ID。
- adjustInput
- 型: ConnectApi.AdjustOrderItemSummaryInputRepresentation
- OrderItemSummaries への価格調整であり、まとまって注文に対する 1 つの価格調整を構成します。履行プロセス中の品目を調整するオプションを使用できます。
使用方法
価格調整が OrderItemSummary に適用される際に、その数量は次の 3 つのグループで考慮されます。
- 履行前
- QuantityAvailableToFulfill。これは QuantityOrdered - QuantityCanceled - QuantityAllocated と等価です。
- 履行中
- QuantityAllocated - QuantityFulfilled
- 履行後
- QuantityAvailableToReturn。これは QuantityFulfilled - QuantityReturnInitiated と等価です。
これらのグループには、3 種類の方法で調整を適用できます。これは、allocatedItemsChangeOrderType 入力プロパティで制御します。
- 調整量を履行前と履行後の数量に均等に配分します。履行中の数量は無視されます。履行前数量の調整に関する変更注文が 1 件と、履行後数量の調整に関する変更注文が 1 件作成されます。
- 調整量を履行前、履行中、および履行後の数量に均等に配分します。履行前数量および履行中数量の両方の調整に関する変更注文が 1 件と、履行後数量の調整に関する変更注文が 1 件作成されます。
- 調整量を履行前、履行中、および履行後の数量に均等に配分します。履行前数量の調整に関する変更注文が 1 件、履行中数量の調整に関する変更注文が 1 件、および履行後数量の調整に関する変更注文が 1 件作成されます。
価格調整を送信したら、必要に応じて返金を処理します。
- 支払が捕捉されていない OrderItemSummaries にのみ割引が適用されている場合、返金は不要です。この状況は通常、米国の履行されていない OrderItemSummaries の場合に当てはまります。
- OrderItemSummaries が、履行されておらず、支払が取得済みの状況で割引が適用される場合は、返金を処理します。この場合、totalExcessFundsAmount を出力表現から ensureRefundsAsync() メソッドに渡します。
- 履行済み OrderItemSummaries に割引が適用される場合は、返金を処理します。この場合、postFulfillmentChangeOrderId を出力表現から createCreditMemo() メソッドに渡し、CreditMemo を ensureRefundsAsync() メソッドに渡します。
- 支払が取得済みの状況で、OrderItemSummaries が履行済みと未履行の両方に割引が適用される場合は、両方の返金を処理します。この場合、postFulfillmentChangeOrderId を出力表現から createCreditMemo() メソッドに渡し、次にクレジットメモと totalExcessFundsAmount を出力表現から ensureRefundsAsync() メソッドに渡します。
createCreditMemo(orderSummaryId, creditMemoInput)
API バージョン
48.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.CreateCreditMemoOutputRepresentation createCreditMemo(String orderSummaryId, ConnectApi.CreateCreditMemoInputRepresentation creditMemoInput)
パラメータ
- orderSummaryId
- 型: String
- OrderSummary の ID。
- creditMemoInput
- 型: ConnectApi.CreateCreditMemoInputRepresentation
- 変更注文 ID のリスト。
ensureFundsAsync(orderSummaryId, ensureFundsInput)
API バージョン
48.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.EnsureFundsAsyncOutputRepresentation ensureFundsAsync(String orderSummaryId, ConnectApi.EnsureFundsAsyncInputRepresentation ensureFundsInput)
パラメータ
- orderSummaryId
- 型: String
- OrderSummary の ID。
- ensureFundsInput
- 型: ConnectApi.EnsureFundsAsyncInputRepresentation
- 請求書の ID。
使用方法
このメソッドは、指定された OrderSummary に関連する OrderPaymentSummaries で、請求書残高に充当する資金をチェックします。このチェックは次のロジックに従って行われます。
- 請求書残高がすべての OrderPaymentSummaries の合計金額を超えていないことを確認してください。
- 補足された金額が請求書の残高と等しい OrderPaymentSummary を探します。存在する場合は、その資金を充当します。
- 完全に一致するものがない場合は、補足された金額が請求書残高よりも大きい OrderPaymentSummaries をすべて特定します。該当するものがある場合は、最小のものを選択し、請求書残高と同額の資金を充当します。
- 補足された金額に請求書残高を超えるものがない場合は、補足された金額の大きい順に OrderPaymentSummaries を選択していきます。請求書残高がゼロになるか、補足された資金をすべて充当するまで、補足された各金額を請求書に充当します。
- 請求書にまだ残高がある場合は、請求書残高の残額に等しい承認金額の OrderPaymentSummary を探します。該当するものがある場合は、その資金を補足して充当します。
- 完全に一致するものがない場合は、承認金額が請求書残高よりも大きい OrderPaymentSummaries をすべて特定します。該当するものがある場合は、最小のものを選択し、請求書残高と同額の資金を充当します。
- 承認金額に請求書残高を超えるものがない場合は、承認金額の大きい順に OrderPaymentSummaries を選択していきます。請求書残高がゼロになるまで、資金を補足して充当します。
ensureRefundsAsync(orderSummaryId, ensureRefundsInput)
API バージョン
48.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.EnsureRefundsAsyncOutputRepresentation ensureRefundsAsync(String orderSummaryId, ConnectApi.EnsureRefundsAsyncInputRepresentation ensureRefundsInput)
パラメータ
- orderSummaryId
- 型: String
- OrderSummary の ID。
- ensureRefundsInput
- 型: ConnectApi.EnsureRefundsAsyncInputRepresentation
- 返金を確認するためのクレジットメモの ID、返金する超過資金の金額、またはこれら両方。少なくとも 1 つは必須項目です。返品手数料など、返金額を減少させる手数料の請求書も含まれます。複数の支払方法が使用可能な場合は、返金の配分方法を指定できます。
使用方法
デフォルトでは、このアクションは、指定された注文概要に関連する注文支払概要で、返金金額についてチェックします。このチェックは次のロジックに従って行われます。全返金額をカバーしない返金シーケンスを指定した場合、isAllowPartial が false であるときは、このロジックに従って残額が返金されます。
- クレジットメモが指定されている場合は、補足された金額が対応する請求書に充当された OrderPaymentSummaries を特定します。
- 該当する OrderPaymentSummaries を確認します。クレジットメモの金額と一致する補足された金額があれば、返金をその支払いに充当します。
- 完全に一致するものがない場合は、補足された金額がクレジットメモの金額よりも大きいものを探します。該当するものがある場合は、返金を最小の補足された金額に充当します。
- クレジットメモの金額を超える補足された金額がない場合は、補足された金額の大きい順に OrderPaymentSummaries を選択していきます。返金がなくなるまでそれらに充当します。
- 余剰資金の金額が指定されている場合は、補足された金額が請求書に充当されていない OrderPaymentSummaries を特定します。
- 該当する OrderPaymentSummaries を確認します。余剰資金の金額と一致する補足された金額があれば、その支払いに返金を充当します。
- 完全に一致するものがない場合は、余剰資金の金額よりも大きな補足された金額を探します。該当するものがある場合は、返金を最小の補足された金額に充当します。
- クレジットメモの金額を超える補足された金額がない場合は、補足された金額の大きい順に OrderPaymentSummaries を選択していきます。返金がなくなるまでそれらに充当します。
previewCancel(orderSummaryId, changeInput)
API バージョン
48.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.PreviewCancelOutputRepresentation previewCancel(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)
パラメータ
- orderSummaryId
- 型: String
- OrderSummary の ID。
- changeInput
- 型: ConnectApi.ChangeInputRepresentation
- キャンセルや返品などの注文変更を構成する OrderItemSummaries への変更のリスト。
previewReturn(orderSummaryId, changeInput)
API バージョン
48.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.PreviewReturnOutputRepresentation previewReturn(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)
パラメータ
- orderSummaryId
- 型: String
- OrderSummary の ID。
- changeInput
- 型: ConnectApi.ChangeInputRepresentation
- キャンセルや返品などの注文変更を構成する OrderItemSummaries への変更のリスト。
submitCancel(orderSummaryId, changeInput)
API バージョン
48.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.SubmitCancelOutputRepresentation submitCancel(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)
パラメータ
- orderSummaryId
- 型: String
- OrderSummary の ID。
- changeInput
- 型: ConnectApi.ChangeInputRepresentation
- キャンセルや返品などの注文変更を構成する OrderItemSummaries への変更のリスト。
submitReturn(orderSummaryId, changeInput)
API バージョン
48.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.SubmitReturnOutputRepresentation submitReturn(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)
パラメータ
- orderSummaryId
- 型: String
- OrderSummary の ID。
- changeInput
- 型: ConnectApi.ChangeInputRepresentation
- キャンセルや返品などの注文変更を構成する OrderItemSummaries への変更のリスト。
使用方法
返品の送信後、返金を処理します。この場合 changeOrderId を出力表現から createCreditMemo() メソッドに渡し、クレジットメモを ensureRefundsAsync() メソッドに渡します。