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. 選択した資金が承認された場合は、資金を捕捉します。
6. 選択した資金を請求書に適用します。

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

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

パラメータ

orderSummaryId

型: String

OrderSummary の ID。

ensureRefundsInput

型: ConnectApi.EnsureRefundsAsyncInputRepresentation

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

戻り値

型: ConnectApi.EnsureRefundsAsyncOutputRepresentation

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() メソッドに渡します。