Connect REST API 開発者ガイド
jB2B および D2C Commerce リソース
コマースデータを取得、作成、更新、削除します。アドレス管理、カート、チェックアウト、注文、商品、プロモーション、税金、ウィッシュリスト、検索の設定を操作します。
次のリソースを使用できます。
アドレス管理
| リソース | 説明 |
|---|---|
| /commerce/webstores/webstoreId/accounts/accountId/addresses | Web ストアの Commerce アカウントアドレスを作成するか、Web ストアアカウントのアドレスのコレクションを取得します。 |
| /commerce/webstores/webstoreId/accounts/accountId/addresses/addressId | Web ストアに関連付けられた Commerce アカウントのアドレスを更新または削除します。 |
カート
チェックアウト
| リソース | 説明 |
|---|---|
| /commerce/webstores/webstoreId/checkouts/activeOrCheckoutId | Commerce ストアのチェックアウトを取得、削除、更新します。 |
| /commerce/webstores/webstoreId/checkouts/activeOrCheckoutId/payments | Commerce ストアのチェックアウトの支払。 |
| /commerce/webstores/webstoreId/checkouts/activeOrCheckoutId/orders | Commerce ストアのチェックアウトの注文を実行します。 |
| /commerce/webstores/webstoreId/checkouts | Commerce ストアのチェックアウトを開始します。 |
| /commerce/webstores/webstoreId/payments/token | Commerce ストアのチェックアウトの支払をトークン化します。 |
コンテキスト
| リソース | 説明 |
|---|---|
| /commerce/webstores/webstoreId/application-context | Commerce ストアのアプリケーションコンテキスト情報を取得します。 |
| /commerce/webstores/webstoreId/session-context | Commerce ストアのセッションコンテキスト情報を取得します。 |
外部管理取引先
| リソース | 説明 |
|---|---|
| /commerce/webstores/webstoreId/external-managed-accounts | 外部管理取引先のコレクションを取得します。 |
拡張機能
| リソース | 説明 |
|---|---|
| /commerce/extension/extensions | 組織で利用可能な Commerce 拡張機能のコレクションを取得します。 |
| /commerce/extension/providers | Commerce 拡張機能プロバイダを取得するか、Commerce 拡張機能プロバイダを登録します。 |
| /commerce/extension/providers/providerId | Commerce 拡張機能プロバイダの取得、削除、変更のいずれかを行います。 |
| /commerce/extension/mappings | 拡張機能プロバイダとウェブストアを関連付ける拡張機能プロバイダマッピングを取得および設定します。 |
| /commerce/extension/mappings/mappingId | Commerce 拡張機能マッピングの削除、取得、変更のいずれかを行います。 |
インポート
| リソース | 説明 |
|---|---|
| /commerce/management/import/category/jobs | .csv ファイルを使用してカテゴリデータを非同期にインポートするためのジョブを作成します。 |
| /commerce/management/import/category/jobs/jobId | .csv ファイルを使用してカテゴリデータを非同期にインポートするためのジョブをキャンセルするか、またはジョブの状況を取得します。 |
| /commerce/management/webstores/webstoreId/product-import | .csv ファイルを使用して B2B または B2C ストアの商品をインポートします。 |
| /commerce/management/import/product/jobs | .csv ファイルを使用して商品データを非同期にインポートするためのジョブを作成します。 |
| /commerce/management/import/product/jobs/jobId | .csv ファイルを使用して商品データを非同期にインポートするためのジョブをキャンセルするか、またはジョブの状況を取得します。 |
注文
| リソース | 説明 |
|---|---|
| /commerce/webstores/webstoreId/order-summaries | 注文概要を取得します。 |
| /commerce/webstores/webstoreId/order-summaries/orderSummaryId | 注文概要を取得します。 |
| /commerce/webstores/webstoreId/order-summaries/orderSummaryId/delivery-groups | 注文配送グループを取得します。 |
| /commerce/webstores/webstoreId/order-summaries/orderSummaryId/items | 注文品目を取得します。 |
| /commerce/webstores/webstoreId/order-summaries/orderSummaryId/shipments | 注文配送を取得します。 |
| /commerce/webstores/webstoreId/order-summaries/async-actions/adjustment-aggregates | ジョブを送信して注文概要 ID のリストについて調整集計を計算します。 |
| /commerce/webstores/webstoreId/order-summaries/actions/lookup | ゲスト買い物客または登録済みバイヤーの OrderSummary に関する詳細を検索します。 |
| /commerce/webstores/webstoreId/shipments/shipmentId/items | 配送品目を取得します。 |
商品、商品カテゴリ、商品価格、商品検索
| リソース | 説明 |
|---|---|
| /commerce/webstores/webstoreId/products | 商品のリストの項目、価格、およびデフォルトの画像を取得します。 |
| /commerce/webstores/webstoreId/products/productId | 商品を取得します。 |
| /commerce/webstores/webstoreId/products/productId/children | 親商品に関連する子商品のコレクションを取得します。 |
| /commerce/webstores/webstoreId/product-categories/children | ストアの特定の親の商品カテゴリに含まれる商品カテゴリを取得するか、最上位レベルの商品カテゴリをすべて取得します。 |
| /commerce/webstores/webstoreId/product-categories/productCategoryId | 商品カテゴリを取得します。 |
| /commerce/webstores/webstoreId/product-category-path/product-categories/productCategoryId | ルートカテゴリから現在のカテゴリへ商品カテゴリパスを取得します。 |
| /commerce/webstores/webstoreId/pricing/products | 複数の商品の価格を取得します。 |
| /commerce/webstores/webstoreId/pricing/products/productId | 商品のリストと購入者価格を取得します。 |
| /commerce/webstores/webstoreId/search/product-search | 商品を検索します。 |
| /commerce/webstores/webstoreId/search/sort-rules | ライブインデックスの並べ替えルールを取得します。 |
| /commerce/webstores/webstoreId/search/suggestions | 商品検索の提案を取得します。 |
プロモーション
| リソース | 説明 |
|---|---|
| /commerce/promotions/actions/evaluate | ストアとバイヤーグループに基づいて、顧客が対象となるプロモーションを判別し、クーポンとカートの品目に基づいて、適用される価格調整を計算します。この API は、有効な手動プロモーションと有効な自動プロモーションを、優先度に基づいてそれぞれ先頭の 50 件のみを評価します。この API は、該当する価格調整を計算して返しますが、その調整を webcart レコードに適用することはありません。配送に基づいたプロモーションを有効にするには、Salesforce カスタマーサポートにお問い合わせください。 |
| /commerce/promotions/actions/evaluate-products | 商品または商品セットにどのプロモーションが適用されるかを決定し、適用される価格調整を計算します。この API は、商品のバリエーションや非連動商品を含む個別の商品を評価しますが、親商品は評価しません。ドメインに連動する使用事例と連動しない使用事例の両方がサポートされています。たとえば、ドメインに連動するコールでは、webstoreId と effectiveAccountId を使用して、内部商品または商品カテゴリに基づいてカート内の商品を評価します。ドメインに連動しないコールでは、SKU または商品カテゴリに基づいて外部データセットが使用されます。 |
| /commerce/promotions/actions/decrease-use/coupon-codes | クーポンコード償還の利用状況を取得して以前に引き換えられたクーポンコードを元に戻します。 |
| /commerce/promotions/actions/increase-use/coupon-codes | クーポンコード償還追加 (増加) の利用状況を取得します。 |
税金
| リソース | 説明 |
|---|---|
| /commerce/webstores/webstoreId/taxes/actions/calculate-taxes | コマース Web ストアの税金を計算します。 |
ウィッシュリスト
| リソース | 説明 |
|---|---|
| /commerce/webstores/webstoreId/wishlists | ウィッシュリストを取得して 1 つのウィッシュリストを作成します。 |
| /commerce/webstores/webstoreId/wishlists/wishlistId | ウィッシュリストの取得、ウィッシュリストの名前の更新、ウィッシュリストの削除を行います。 |
| /commerce/webstores/webstoreId/wishlists/wishlistId/actions/add-wishlist-to-cart | カートにウィッシュリストを追加します。 |
| /commerce/webstores/webstoreId/wishlists/wishlistId/wishlist-items | ウィッシュリスト品目を取得したり、品目をウィッシュリストに追加したりします。 |
| /commerce/webstores/webstoreId/wishlists/wishlistId/wishlist-items/wishlistItemId | ウィッシュリスト品目を削除します。 |