Connect REST API 開発者ガイド
jSalesforce Order Management リソース
注文および注文履行プロセスを管理します。Salesforce Order Management 組織で使用できます。
次のリソースを使用できます。
| リソース | 説明 |
|---|---|
| /commerce/fulfillment/fulfillment-orders | OrderSummary の配送方法と受信者を定義する OrderDeliveryGroupSummary の 1 つ以上の FulfillmentOrders および FulfillmentOrderLineItems を作成します。割り当てる OrderItemSummaries を指定します。これは、異なる場所から履行できます。複数の履行グループを指定すると、場所ごとに 1 つ FulfillmentOrder が作成されます。OrderItemSummary ごとに、FulfillmentOrderLineItem が作成され、対応する FulfillmentOrder に割り当てられます。 |
| /commerce/fulfillment/fulfillment-orders/fulfillmentOrderId/actions/cancel-item | FulfillmentOrder から FulfillmentOrderLineItems をキャンセルします。このアクションでは、関連付けられた OrderItemSummaries はキャンセルされないため、キャンセルした数量を新しい FulfillmentOrder に再度割り当ててください。 |
| /commerce/fulfillment/fulfillment-orders/fulfillmentOrderId/actions/create-invoice | 請求書のない FulfillmentOrder の請求書を作成します。 |
| /commerce/fulfillment/actions/create-multiple | 1 回の要求で複数の OrderDeliveryGroups の FulfillmentOrders を作成します。 |
| /commerce/fulfillment/actions/create-multiple-invoices | 複数の FulfillmentOrders の請求書を作成します。 |
| /commerce/order-management/analytics/insights/products-return-rate | 返品率のある商品ページを取得します。 |
| /commerce/order-management/exchanges/actions/preview-cart-to-exchange-order | 交換注文のプレビューを取得します。このアクションでは、注文概要の��高と、返品注文と交換注文を表すカートとの差額が考慮されます。 |
| /commerce/order-management/exchanges/actions/submit-cart-to-exchange-order | 返品注文と交換に使用されたカートに基づいて、交換注文の概要を作成します。新しい交換注文の概要は、元の注文概要 (交換が発生する前に作成されたもの) に添付されます。また、新しく作成される交換注文の概要に影響を与える、オプションの支払い情報や注文概要のシーケンスに関するオプション情報を追加することもできます。 |
| /commerce/order-management/order-payment-summaries | OrderSummary の OrderPaymentSummary を作成します。支払承認、または同じ支払い方法を共有する、支払いを指定します。組織でマルチ通貨が有効になっている場合、OrderPaymentSummary は、OrderSummary からの CurrencyIsoCode 値を継承します。 |
| /commerce/order-management/order-summaries | 注文に基づいて OrderSummary を作成します。この注文は OrderSummary の元の注文とみなされます。OrderSummary に適用される後続の変更注文も注文として表されます。注文を Salesforce Order Management で管理するのか、外部システムで管理するのかを指定できます。ほとんどの Salesforce Order Management API は、管理対象の注文にのみ実行できます。 |
| /commerce/order-management/order-summaries/orderSummaryId/actions/create-credit-memo | クレジットメモを作成し、OrderSummary に関連付けられた 1 つ以上の変更注文の返金を表します。 |
| /commerce/order-management/order-summaries/actions/create-multiple-change-invoices | 1 つ以上の変更注文の請求を表す請求書を作成します。返品手数料の請求書など、注文金額を増加させる変更注文の請求書を作成します。返品に対する返金を確認するときは、関連する返品手数料の請求書を要求に含めます。 |
| /commerce/order-management/order-summaries/orderSummaryId/async-actions/ensure-funds-async | 請求書の資金を確認して適用します。必要に応じて、支払プロバイダーに要求を送信して承認済み資金を捕捉します。この方法によってバックグラウンド操作が非同期ジョブキューに挿入され、その操作の ID が返されるため、ユーザーはその状況を追跡できます。支払ゲートウェイ応答は、支払ゲートウェイログに表示され、バックグラウンド操作状況には影響しません。 |
| /commerce/order-management/order-summaries/orderSummaryId/async-actions/ensure-refunds-async | 支払プロバイダーに要求を送信して、CreditMemo または超過資金の返金を確認します。この方法によってバックグラウンド操作が非同期ジョブキューに挿入され、その操作の ID が返されるため、ユーザーはその状況を追跡できます。支払ゲートウェイ応答は、支払ゲートウェイログに表示され、バックグラウンド操作状況には影響しません。 |
| /commerce/order-management/order-summaries/async-actions/multiple-ensure-funds-async | 1 つ以上の請求書の資金を確認して充当します。必要に応じて、支払プロバイダーに要求を送信して承認済み資金を捕捉します。この方法によってバックグラウンド操作が非同期ジョブキューに挿入され、その操作の ID が返されるため、ユーザーはその状況を追跡できます。支払ゲートウェイ応答は、支払ゲートウェイログに表示され、バックグラウンド操作状況には影響しません。 |
| /commerce/order-management/order-summaries/orderSummaryId/actions/adjust-item-preview | 実際に調整を実行することなく、OrderSummary の 1 つ以上の OrderItemSummaries の価格を調整した場合に期待される結果を取得します。応答データには、提案された調整の送信によって生じる財務上の変更が含まれています。 |
| /commerce/order-management/order-summaries/orderSummaryId/actions/preview-cancel | 実際にキャンセルを実行することなく、OrderSummary の 1 つ以上の OrderItemSummaries をキャンセルした場合に予想される変更注文金額を取得します。 |
| /commerce/order-management/order-summaries/orderSummaryId/actions/preview-return | 実際に返品を実行することなく、単に OrderSummary の 1 つ以上の OrderItemSummaries を返品した場合に予想される変更注文金額を取得します。 |
| /commerce/order-management/order-summaries/orderSummaryId/actions/adjust-item-submit | OrderSummary の 1 つ以上の OrderItemSummaries の価格を調整し、対応する変更注文を作成します。 |
| /commerce/order-management/order-summaries/orderSummaryId/actions/submit-cancel | OrderSummary から 1 つ以上の OrderItemSummaries をキャンセルし、対応する変更注文を作成します。 |
| /commerce/order-management/order-summaries/orderSummaryId/actions/submit-return | OrderSummary の 1 つ以上の OrderItemSummaries を返品し、対応する変更注文を作成します。この返品は、ReturnOrder ではなく変更注文を作成する単純な返品です。 |
| /commerce/order-management/webstores/webstoreId/products | 検索語で Web ストアの商品を検索します。 |
| /commerce/order-management/webstores/webstoreId/products/skuOrProductId | Web ストアの商品の詳細を取得します。 |
| /commerce/returns/return-orders/ | OrderSummary に属する品目の ReturnOrder と ReturnOrderLineItems を作成します。 |
| /commerce/returns/return-orders/returnOrderId/actions/return-items | ReturnOrder に属する ReturnOrderLineItems を処理します。ReturnOrderLineItem の処理により、変更注文が生成され、ReturnOrderLineItem が読み取り専用になります。返される品目または配送料に対する変更注文は正の金額で、クレジットメモの作成に使用する必要があります。返品手数料の変更注文は負の金額で、請求書の作成に使用する必要があります。処理済みの ReturnOrderLineItem に想定される数量が残っている場合、API がその数量を表す別の ReturnOrderLineItem を作成します。 |
| /commerce/order-management/routing/fulfillment-order-capacity/actions/confirm-held-capacity | 1 つ以上のロケーションで保持されている履行注文容量を確認します。このコールにより、ロケーションの保持容量が減少し、割り当て済み履行注文数が増加します。ロケーションに履行注文を割り当てる際に、保持されている容量を確認します。 |
| /commerce/order-management/routing/actions/find-routes-with-fewest-splits | 指定された配送分割の制限内で注文を履行できる在庫ロケーションの組み合わせを返します。デフォルトでは、潜在的な経路を最大 1,000,000 件チェックして、最大 10,000 件の結果を返します。 |
| /commerce/order-management/routing/actions/find-routes-with-fewest-splits-using-oci | 1 つ以上の注文概要について、オムニチャネル在庫を使用して在庫状況を検索し、分割が最も少ない履行ルートを識別します。このメソッドは、Get Inventory Availability リソースと Find Routes With Fewest Splits リソースの機能を組み合わせたものです。 |
| /commerce/order-management/routing/fulfillment-order-capacity/actions/get-capacity-values | 1 つ以上のロケーションの現在の履行注文容量に関する情報を取得します。 |
| /commerce/order-management/routing/fulfillment-order-capacity/actions/hold-capacity | あるロケーションの履行注文容量を保持します。ロケーションの保持容量は、そのロケーションに割り当てる履行注文用の容量を確保するためのものです。 |
| /commerce/order-management/routing/actions/rank-byaverage-distance | 在庫ロケーションのセットから注文受取人までの平均距離を計算し、ランク付けします。注文を履行できる複数のロケーションセットの平均配送距離を比較するには、このメソッドを使用します。 |
| /commerce/order-management/routing/fulfillment-order-capacity/actions/release-held-capacity | 1 つ以上のロケーションで保持されている履行注文容量を解放します。このコールにより、割り当て済み履行注文数に変化がなくても、ロケーションで保持される容量が減少します。ロケーションへの履行注文の割り当てを取り消すと、保持済みの容量が解放されます。 |
| /commerce/order-summaries/ | 注文概要グラフから保留中の注文概要を作成します。高スケール注文機能が有効である必要がありますが、B2C Commerce 接続は不要です。作成された保留中の注文概要は、B2C Commerce から取り込まれた保留中の注文概要と同様に、キューに登録されて注文概要へと自動処理されます。提供される JSON の例では、個人取引先が参照されていますが、法人取引先もサポートされています。 |
| /commerce/webstores/webstoreId/accounts/accountId/actions/register-guest-buyer | アカウント ID を使用して、Web ストアのゲストバイヤーを登録します。このアクションで、ゲストバイヤーが他のバイヤーの代理で注文できるようになります。 |