OrderSummary クラス

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

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

パラメータ

orderSummaryId

型: String

OrderSummary の ID。

adjustInput

型: ConnectApi.AdjustOrderItemSummaryInputRepresentation

注文の価格調整を構成する OrderItemSummaries への価格調整のリスト。

戻り値

型: ConnectApi.AdjustOrderSummaryOutputRepresentation

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

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

パラメータ

orderSummaryId

型: String

OrderSummary の ID。

adjustInput

型: ConnectApi.AdjustOrderItemSummaryInputRepresentation

注文の価格調整を構成する OrderItemSummaries への価格調整のリスト。

戻り値

型: ConnectApi.AdjustOrderSummaryOutputRepresentation

使用方法

価格調整を送信したら、必要に応じて返金を処理します。

• 支払が未取得の OrderItemSummaries にのみ割引が適用される場合、返金は必要ありません。この状況は通常、米国の履行されていない OrderItemSummaries の場合に当てはまります。
• OrderItemSummaries が、履行されておらず、支払が取得済みの状況で割引が適用される場合は、返金を処理します。この場合、totalExcessFundsAmount を出力表現から ensureRefundsAsync() メソッドに渡します。
• 履行済み OrderItemSummaries に割引が適用される場合は、返金を処理します。この場合、postFulfillmentChangeOrderId を出力表現から createCreditMemo() メソッドに渡し、CreditMemo を ensureRefundsAsync() メソッドに渡します。
• 支払が取得済みの状況で、OrderItemSummaries が履行済みと未履行の両方に割引が適用される場合は、両方の返金を処理します。この場合、postFulfillmentChangeOrderId を出力表現から createCreditMemo() メソッドに渡し、次にクレジットメモと totalExcessFundsAmount を出力表現から ensureRefundsAsync() メソッドに渡します。

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

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

パラメータ

orderSummaryId

型: String

OrderSummary の ID。

creditMemoInput

型: ConnectApi.CreateCreditMemoInputRepresentation

変更注文 ID のリスト。

戻り値

型: ConnectApi.CreateCreditMemoOutputRepresentation

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 で、請求書残高に充当する資金をチェックします。このチェックは次のロジックに従って行われます。

1. 請求書残高がすべての OrderPaymentSummaries の合計金額を超えていないことを確認してください。
2. 補足された金額が請求書の残高と等しい OrderPaymentSummary を探します。存在する場合は、その資金を充当します。
3. 完全に一致するものがない場合は、補足された金額が請求書残高よりも大きい OrderPaymentSummaries をすべて特定します。該当するものがある場合は、最小のものを選択し、請求書残高と同額の資金を充当します。
4. 補足された金額に請求書残高を超えるものがない場合は、補足された金額の大きい順に OrderPaymentSummaries を選択していきます。請求書残高がゼロになるか、補足された資金をすべて充当するまで、補足された各金額を請求書に充当します。
5. 請求書にまだ残高がある場合は、請求書残高の残額に等しい承認金額の OrderPaymentSummary を探します。該当するものがある場合は、その資金を補足して充当します。
6. 完全に一致するものがない場合は、承認金額が請求書残高よりも大きい OrderPaymentSummaries をすべて特定します。該当するものがある場合は、最小のものを選択し、請求書残高と同額の資金を充当します。
7. 承認金額に請求書残高を超えるものがない場合は、承認金額の大きい順に OrderPaymentSummaries を選択していきます。請求書残高がゼロになるまで、資金を補足して充当します。

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

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

パラメータ

orderSummaryId

型: String

OrderSummary の ID。

ensureRefundsInput

型: ConnectApi.EnsureRefundsAsyncInputRepresentation

クレジットメモの ID と余剰資金の金額をラップするオブジェクト。

戻り値

型: ConnectApi.EnsureRefundsAsyncOutputRepresentation

使用方法

このメソッドは、指定された OrderSummary に関連する OrderPaymentSummaries で返金金額についてチェックします。このチェックは次のロジックに従って行われます。

1. クレジットメモが指定されている場合は、補足された金額が対応する請求書に充当された OrderPaymentSummaries を特定します。
   1. 該当する OrderPaymentSummaries を確認します。クレジットメモの金額と一致する補足された金額があれば、返金をその支払いに充当します。
   2. 完全に一致するものがない場合は、補足された金額がクレジットメモの金額よりも大きいものを探します。該当するものがある場合は、返金を最小の補足された金額に充当します。
   3. クレジットメモの金額を超える補足された金額がない場合は、補足された金額の大きい順に OrderPaymentSummaries を選択していきます。返金がなくなるまでそれらに充当します。
2. 余剰資金の金額が指定されている場合は、補足された金額が請求書に充当されていない OrderPaymentSummaries を特定します。
   1. 該当する OrderPaymentSummaries を確認します。余剰資金の金額と一致する補足された金額があれば、その支払いに返金を充当します。
   2. 完全に一致するものがない場合は、余剰資金の金額よりも大きな補足された金額を探します。該当するものがある場合は、返金を最小の補足された金額に充当します。
   3. クレジットメモの金額を超える補足された金額がない場合は、補足された金額の大きい順に OrderPaymentSummaries を選択していきます。返金がなくなるまでそれらに充当します。

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.PreviewCancelOutputRepresentation previewCancel(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)

パラメータ

orderSummaryId

型: String

OrderSummary の ID。

changeInput

型: ConnectApi.ChangeInputRepresentation

キャンセルや返品などの注文変更を構成する OrderItemSummaries への変更のリスト。

戻り値

型: ConnectApi.PreviewCancelOutputRepresentation

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.PreviewReturnOutputRepresentation previewReturn(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)

パラメータ

orderSummaryId

型: String

OrderSummary の ID。

changeInput

型: ConnectApi.ChangeInputRepresentation

キャンセルや返品などの注文変更を構成する OrderItemSummaries への変更のリスト。

戻り値

型: ConnectApi.PreviewReturnOutputRepresentation

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.SubmitCancelOutputRepresentation submitCancel(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)

パラメータ

orderSummaryId

型: String

OrderSummary の ID。

changeInput

型: ConnectApi.ChangeInputRepresentation

キャンセルや返品などの注文変更を構成する OrderItemSummaries への変更のリスト。

戻り値

型: ConnectApi.SubmitCancelOutputRepresentation

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.SubmitReturnOutputRepresentation submitReturn(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)

パラメータ

orderSummaryId

型: String

OrderSummary の ID。

changeInput

型: ConnectApi.ChangeInputRepresentation

キャンセルや返品などの注文変更を構成する OrderItemSummaries への変更のリスト。

戻り値

型: ConnectApi.SubmitReturnOutputRepresentation

使用方法

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