OrderSummary クラス

adjustPreview(orderSummaryId, adjustInput)

実際に調整を実行することなく、OrderSummary の 1 つ以上の OrderItemSummaries の価格を調整した場合に期待される結果を取得します。応答データには、提案された調整の送信によって生じる財務上の変更が含まれています。

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.AdjustOrderSummaryOutputRepresentation adjustPreview(String orderSummaryId, ConnectApi.AdjustOrderItemSummaryInputRepresentation adjustInput)

パラメーター

orderSummaryId: 型: String; OrderSummary の ID。
adjustInput: 型: ConnectApi.AdjustOrderItemSummaryInputRepresentation; 注文品目概要への価格調整であり、まとまって注文に対する 1 つの価格調整を構成します。履行プロセス中の品目を調整するオプションを使用できます。

戻り値

型: ConnectApi.AdjustOrderSummaryOutputRepresentation

使用方法

価格調整が OrderItemSummary に適用される際に、その数量は次の 3 つのグループで考慮されます。

履行前: QuantityAvailableToFulfill。これは QuantityOrdered - QuantityCanceled - QuantityAllocated と等価です。
履行中: QuantityAllocated - QuantityFulfilled
履行後: QuantityAvailableToReturn。これは QuantityFulfilled - QuantityReturnInitiated と等価です。

これらのグループには、3 種類の方法で調整を適用できます。これは、allocatedItemsChangeOrderType 入力プロパティで制御します。

調整量を履行前と履行後の数量に均等に配分します。履行中の数量は無視されます。調整を送信すると、履行前数量の調整に関する変更注文が 1 件と、履行後数量の調整に関する変更注文が 1 件作成されます。
調整量を履行前、履行中、および履行後の数量に均等に配分します。調整を送信すると、履行前数量および履行中数量の両方の調整に関する変更注文が 1 件と、履行後数量の調整に関する変更注文が 1 件作成されます。
調整量を履行前、履行中、および履行後の数量に均等に配分します。調整を送信すると、履行前数量の調整に関する変更注文が 1 件、履行中数量の調整に関する変更注文が 1 件、および履行後数量の調整に関する変更注文が 1 件作成されます。

adjustSubmit(orderSummaryId, adjustInput)

OrderSummary の 1 つ以上の OrderItemSummaries の価格を調整し、対応する変更注文を作成します。

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.AdjustOrderSummaryOutputRepresentation adjustSubmit(String orderSummaryId, ConnectApi.AdjustOrderItemSummaryInputRepresentation adjustInput)

パラメーター

orderSummaryId: 型: String; OrderSummary の ID。
adjustInput: 型: ConnectApi.AdjustOrderItemSummaryInputRepresentation; 注文品目概要への価格調整であり、まとまって注文に対する 1 つの価格調整を構成します。履行プロセス中の品目を調整するオプションを使用できます。

戻り値

型: ConnectApi.AdjustOrderSummaryOutputRepresentation

使用方法

価格調整が 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)

クレジットメモを作成し、OrderSummary に関連付けられた 1 つ以上の変更注文の返金を表します。

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CreateCreditMemoOutputRepresentation createCreditMemo(String orderSummaryId, ConnectApi.CreateCreditMemoInputRepresentation creditMemoInput)

パラメーター

orderSummaryId: 型: String; OrderSummary の ID。
creditMemoInput: 型: ConnectApi.CreateCreditMemoInputRepresentation; 変更注文 ID のリスト。

戻り値

型: ConnectApi.CreateCreditMemoOutputRepresentation

ensureFundsAsync(orderSummaryId, ensureFundsInput)

請求書の資金を確認して適用します。必要に応じて、支払プロバイダーに要求を送信して承認済み資金を捕捉します。この方法によってバックグラウンド操作が非同期ジョブキューに挿入され、その操作の ID が返されるため、ユーザーはその状況を追跡できます。支払ゲートウェイ応答は、支払ゲートウェイログに表示され、バックグラウンド操作状況には影響しません。

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.EnsureFundsAsyncOutputRepresentation ensureFundsAsync(String orderSummaryId, ConnectApi.EnsureFundsAsyncInputRepresentation ensureFundsInput)

パラメーター

orderSummaryId: 型: String; OrderSummary の ID。
ensureFundsInput: 型: ConnectApi.EnsureFundsAsyncInputRepresentation; 請求書の ID。

戻り値

型: ConnectApi.EnsureFundsAsyncOutputRepresentation

使用方法

このメソッドは、指定された OrderSummary に関連する OrderPaymentSummaries で、請求書残高に充当する資金をチェックします。このチェックは次のロジックに従って行われます。

複数の OrderPaymentSummaries に同じ BalanceAmount 値がある場合、選択の順序はランダムです。

メモ

請求書残高が、OrderSummary に関連付けられているすべての OrderPaymentSummaries の合計 BalanceAmount を超えていないことを確認します。
OrderPaymentSummary の BalanceAmount が請求書残高に等しい場合は、その OrderPaymentSummary から資金を充当します。
完全に一致するものがない場合は、BalanceAmount が最大の OrderPaymentSummary から資金を充当します。
請求書に確認すべき残高がまだある場合は、完全な残高が確認されるまで、または捕捉された資金の残りがなくなるまで、ステップ 2 と 3 を繰り返します。
請求書にまだ残高がある場合は、請求書残高の残額に等しい承認金額の OrderPaymentSummary を探します。該当するものがある場合は、その OrderPaymentSummary から資金を捕捉して充当します。
完全に一致するものがない場合は、承認金額が最大の OrderPaymentSummary から資金を捕捉して充当します。
請求書に確認すべき残高がまだある場合は、完全な残高が確認されるまで、ステップ 5 と 6 を繰り返します。

メソッドで支払が作成される場合、支払レコードの ClientContext 値は予測不能です。この値をカスタムロジックでは使用しないでください。

メモ

ensureRefundsAsync(orderSummaryId, ensureRefundsInput)

支払プロバイダーに要求を送信して、CreditMemo または超過資金の返金を確認します。この方法によってバックグラウンド操作が非同期ジョブキューに挿入され、その操作の ID が返されるため、ユーザーはその状況を追跡できます。支払ゲートウェイ応答は、支払ゲートウェイログに表示され、バックグラウンド操作状況には影響しません。

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.EnsureRefundsAsyncOutputRepresentation ensureRefundsAsync(String orderSummaryId, ConnectApi.EnsureRefundsAsyncInputRepresentation ensureRefundsInput)

パラメーター

orderSummaryId: 型: String; OrderSummary の ID。
ensureRefundsInput: 型: ConnectApi.EnsureRefundsAsyncInputRepresentation; 返金を確認するためのクレジットメモの ID、返金する超過資金の金額、またはこれら両方。少なくとも 1 つは必須項目です。返品手数料など、返金額を減少させる手数料の請求書も含まれます。複数の支払方法が使用可能な場合は、返金の配分方法を指定できます。

戻り値

型: ConnectApi.EnsureRefundsAsyncOutputRepresentation

使用方法

次の方法により、このロジックに従って指定された OrderSummary に関連付けられた OrderPaymentSummaries に返金が適用されます。

複数の OrderPaymentSummaries に同じ金額の AvailableToRefund がある場合、選択の順序はランダムです。

メモ

CreditMemo の残高と超過資金の金額が、OrderSummary に関連付けられているすべての OrderPaymentSummaries の AvailableToRefund の合計金額を超えていないことを確認します。
sequences が指定されている場合は、次の手順を実行します。
1. sequences リストを順番にトラバースし、指定の返金額を指定の OrderPaymentSummaries に適用します。
2. 指定された CreditMemo および超過資金が完全に返金された場合、または isAllowPartial が true の場合は、ここでアクションが停止します。
CreditMemo が指定された場合は、次の手順に従います。
1. OrderPaymentSummary の AvailableToRefund の金額が CreditMemo の残高に一致する場合は、その支払いに返金を適用します。
2. 完全に一致するものがない場合は、AvailableToRefund の金額が最大の OrderPaymentSummary に返金を適用します。
3. CreditMemo に残高がある場合は、その残高が完全に返金されるまで手順 a と b を繰り返します。
超過資金の金額が指定されている場合は、次の手順に従います。
1. 該当する OrderPaymentSummaries を確認します。超過資金の金額と一致する金額の AvailableToRefund があれば、その OrderPaymentSummary に返金を適用します。
2. 完全に一致するものがない場合は、AvailableToRefund の金額が最大の OrderPaymentSummary に返金を適用します。
3. 超過資金が残っている場合は、完全に返金されるまでステップ a および b を繰り返します。

メソッドで返金が作成される場合、返金レコードの ClientContext 値は予測不能です。この値をカスタムロジックでは使用しないでください。

返品の送信後、返金を処理します。この場合 changeOrderId を出力表現から createCreditMemo() メソッドに渡し、クレジットメモを ensureRefundsAsync() メソッドに渡します。

Apex 開発者ガイド

名前空間

OrderSummary のメソッド

adjustPreview(orderSummaryId, adjustInput)

API バージョン

Chatter が必要かどうか

署名

パラメーター

戻り値

使用方法

関連項目:

adjustSubmit(orderSummaryId, adjustInput)

API バージョン

Chatter が必要かどうか

署名

パラメーター

戻り値

使用方法

関連項目:

createCreditMemo(orderSummaryId, creditMemoInput)

API バージョン

Chatter が必要かどうか

署名

パラメーター

戻り値

ensureFundsAsync(orderSummaryId, ensureFundsInput)

API バージョン

Chatter が必要かどうか

署名

パラメーター

戻り値

使用方法

ensureRefundsAsync(orderSummaryId, ensureRefundsInput)

API バージョン

Chatter が必要かどうか

署名

パラメーター

戻り値

使用方法

previewCancel(orderSummaryId, changeInput)

API バージョン

Chatter が必要かどうか

署名

パラメーター

戻り値

関連項目:

previewReturn(orderSummaryId, changeInput)

API バージョン

Chatter が必要かどうか

署名

パラメーター

戻り値

関連項目:

submitCancel(orderSummaryId, changeInput)

API バージョン

Chatter が必要かどうか

署名

パラメーター

戻り値

関連項目:

submitReturn(orderSummaryId, changeInput)

API バージョン

Chatter が必要かどうか

署名

パラメーター

戻り値

使用方法

関連項目: