1. ホームページ
  2. Salesforce Commerce Cloud B2C Data Connector

  3. Salesforce Commerce Cloud B2C Data Connector リファレンス

All Connectors

Salesforce Commerce Cloud B2C Data Connector リファレンス - Mule 4

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

Salesforce Commerce Cloud B2C データ用 Anypoint Connector (B2C Data Connector) は、操作ベースのコネクタです。つまり、コネクタをフローに追加するときに、コネクタで実行する特定の操作を設定する必要があります。

B2C Data Connector では、接続で OAuth 2 認証設定がサポートされています。

制限事項

  • Salesforce Commerce Cloud B2C Data Connector と Salesforce Commerce Cloud B2C Shop Connector は同じアプリケーションで実行できません。

OAuth2 設定

OAuth 2.0 を使用して、ユーザーアカウントをホストするサービスにユーザー認証を委任します。詳細は、​「コネクタの OAuth 2.0 の設定」​または​「CloudHub でのコネクタの OAuth 2.0 の設定」​を参照してください。

パラメーター

名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

X

Connection (接続)

この設定に指定する接続型。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

1

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

MINUTES (分)

Expiration Policy (有効期限ポリシー)

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。

Oauth2 アプリケーション接続プロバイダー

パラメーター

名前 型 説明 デフォルト値 必須

Default Headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー)​ の配列

クエリパラメーター

Default Query Param (デフォルトクエリパラメーター)​ の配列

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサービスへの接続を確立するためのタイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Connection Timeout (接続タイムアウト) の時間単位。

SECONDS (秒)

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false​ の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

接続アイドルタイムアウトの時間単位。

SECONDS (秒)

Proxy Config (プロキシ設定)

Proxy (プロキシ)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

Stream Response (応答のストリーミング)

Boolean (ブール)

受信した応答ストリーミングするかどうか。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの容量 (バイト)。

-1

Base Uri (ベース URI)

String (文字列)

パラメーターのベース URI。各インスタンスまたはテナントが独自のベース URI を取得します。

デフォルトのベース URI

Protocol (プロトコル)

Enumeration (列挙)。次のいずれかになります。

  • HTTP

  • HTTPS

通信に使用するプロトコル。有効な値は HTTP と HTTPS です。

HTTP

TLS 設定

TLS

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Client Id (クライアント ID)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアント ID。詳細は、Salesforce にお問い合わせください。

X

Client Secret (クライアントシークレット)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアントシークレット。詳細は、Salesforce にお問い合わせください。

X

Token Url (トークン URL)

String (文字列)

サービスプロバイダーのトークンエンドポイント URL。

デフォルトのトークン URL

Scopes (スコープ)

String (文字列)

OAuth ダンス時に要求する OAuth スコープ。

X

Object Store (オブジェクトストア)

String (文字列)

各リソースオーナー ID のデータの保存に使用するオブジェクトストアへの参照。指定されていない場合、Mule が自動的にデフォルトのオブジェクトストアをプロビジョニングします。

操作

Assign Product To Category

<commerce-cloud-dataapi:assign-product-to-category>

指定された情報を使用して、カテゴリ商品割り当てを作成します。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/products/{productId}​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Assign Variation For Master Product

<commerce-cloud-dataapi:assign-variation-for-master-product>

商品マスターの変数を割り当てます。バリエーション商品が初期状態で存在していない場合、渡される本文を使用して作成されます。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/{masterProductId}/variations​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

マスター商品 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Assign Variation Group To Master Product

<commerce-cloud-dataapi:assign-variation-group-to-master-product>

商品マスターのバリエーショングループを割り当てます。バリエーショングループが初期状態で存在していない場合、渡される本文を使用して作成されます。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/{masterProductId}/variation-groups​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

マスター商品 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Assignments Search

<commerce-cloud-dataapi:assignment-search>

割り当ての検索操作を実行します。 この操作では、​/pricing/assignments/{{version}}/organizations/{{organizationId}}/assignments​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Campaigns Search

<commerce-cloud-dataapi:campaigns-search>

さまざまな属性で絞り込むことができる検索要求オブジェクトを使用してキャンペーンを検索します。 この操作では、/pricing/campaigns/{version}/organizations/{organizationId}/campaigns エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Coupon Redemptions Search

<commerce-cloud-dataapi:coupon-redemptions-search>

クーポンの使用を検索します。Coupon Redemption Search ドキュメントには、さまざまな属性で絞り込むことができる検索オブジェクトが含まれます。 この操作では、​/pricing/coupons/{version}/organizations/{organizationId}/coupons/redemptions​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Coupons Search

<commerce-cloud-dataapi:coupons-search>

クーポンを検索します。 この操作では、​/pricing/coupons/{version}/organizations/{organizationId}​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Address For Customer In Customer List

<commerce-cloud-dataapi:create-address-for-customer-in-customer-list>

クーポンを検索します。 この操作では、​/pricing/coupons/{version}/organizations/{organizationId}​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Campaign

<commerce-cloud-dataapi:create-campaign>

指定された情報を使用して、キャンペーンを作成します。 この操作では、/pricing/campaigns/{version}/organizations/{organizationId}/campaigns/{campaignId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

campaignId

String (文字列)

キャンペーンの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Category In Catalog

<commerce-cloud-dataapi:create-category-in-catalog>

指定された情報を使用して、カタログカテゴリを作成します。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Coupon

<commerce-cloud-dataapi:create-coupon>

指定された情報を使用して、クーポンを作成します。同じ一意の識別子のクーポンが存在する場合、そのクーポンは完全に置き換えられます。 この操作では、​/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

couponId

String (文字列)

作成するクーポンの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Customer In Customer List

<commerce-cloud-dataapi:create-customer-in-customer-list>

新規顧客を作成するアクション。顧客は、指定された顧客番号、ログイン情報、および顧客情報を使用して作成されます。

このアクションは、以下を検証します。

  • ログインの承認条件と一意性

  • 顧客の必須プロパティ

このアクションで顧客を作成できなかった場合、該当するメッセージと共に ​400​ エラーが返されます。

この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

listId

String (文字列)

顧客を追加するリスト ID。

X

customerNo

String (文字列)

顧客番号。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Customer List

<commerce-cloud-dataapi:create-customer-list>

新規顧客を作成するアクション。顧客は、指定された顧客ログイン情報と顧客情報を使用して作成されます。

このアクションは、以下を検証します。

  • ログインの承認条件と一意性

  • 顧客の必須プロパティ

このアクションで顧客を作成できなかった場合、該当するメッセージと共に ​400​ エラーが返されます。

この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

listId

String (文字列)

顧客を追加するリスト ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Gift Certificate

<commerce-cloud-dataapi:create-gift-certificate>

指定された情報を使用して、ギフト券を作成します。同じ一意の識別子のギフト券が生成された場合、そのギフト券は削除されて、新しいギフト券が作成されます。 この操作では、​/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Product

<commerce-cloud-dataapi:create-product>

指定された情報を使用して、商品を作成します。同じ一意の識別子の商品が存在する場合、要求でヘッダー ​x-dw-validate-existing=true​ が渡されるまで上書きされます。

この操作では、​/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Product Option

<commerce-cloud-dataapi:create-product-option>

指定された情報を使用して、ローカル商品オプションを作成したり、共有商品オプションを商品にバインドしたりします。

この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{id}​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

id

String (文字列)

ローカルまたは共有商品オプションの ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Product Option Value

<commerce-cloud-dataapi:create-product-option-value>

指定された情報を使用して、ローカル商品オプション値を作成します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{id}​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

optionId

String (文字列)

ローカル商品オプションの ID。

X

id

String (文字列)

ローカル商品オプション値の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create promotion

<commerce-cloud-dataapi:create-promotion>

指定された情報を使用して、プロモーションを作成します。 この操作では、​/pricing/promotions/{version}/organizations/{organizationId}/promotions/{id}​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

id

String (文字列)

作成するプロモーションの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Source Code Group

<commerce-cloud-dataapi:create-source-code-group>

指定された情報を使用して、ソースコードグループを作成します。 この操作では、/pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

id

String (文字列)

作成するソースコードグループの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Variation Attribute

<commerce-cloud-dataapi:create-variation-attribute>

指定された情報を使用して、バリエーション属性を作成します。 この操作では、/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品の ID。

X

id

String (文字列)

バリエーション属性の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Create Variation Attribute Value

<commerce-cloud-dataapi:create-variation-attribute-value>

商品バリエーション属性値を作成するアクション。 この操作では、​product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{id}​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品の ID。

X

id

String (文字列)

バリエーション属性値の ID。

X

attributeId

String (文字列)

バリエーション属性 ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Campaign

<commerce-cloud-dataapi:delete-campaign>

ID でキャンペーンを削除します。 この操作では、​/pricing/campaigns/{version}/organizations/{organizationId}/campaigns/{campaignId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

campaignId

String (文字列)

キャンペーンの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Category From Catalog

<commerce-cloud-dataapi:delete-category-from-catalog>

カタログ ID とカテゴリ ID でカテゴリを削除します。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

categoryId

String (文字列)

作成するカテゴリの ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Coupon

<commerce-cloud-dataapi:delete-coupon>

ID でクーポンを削除します。 この操作では、​/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

couponId

String (文字列)

削除するクーポンの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Customer From Customer List

<commerce-cloud-dataapi:delete-customer-from-customer-list>

顧客 (顧客住所などのすべての関連情報を含む) を削除します。 この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

listId

String (文字列)

顧客を削除するリスト ID。

X

customerNo

String (文字列)

顧客番号。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Gift Certificate

<commerce-cloud-dataapi:delete-gift-certificate>

販売店 ID でギフト券を削除します。 この操作では、​/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates/{merchantId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

merchantId

String (文字列)

要求されたギフト券の販売店 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Product

<commerce-cloud-dataapi:delete-product>

ID で商品を削除します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Product Option

<commerce-cloud-dataapi:delete-product-option>

ローカル商品オプションを削除したり、共有商品オプションを商品から削除したりします。 この操作では、/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

id

String (文字列)

ローカルまたは共有商品オプションの ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Product Option Value

<commerce-cloud-dataapi:delete-product-option-value>

ID でローカル商品オプション値を削除します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{id}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

id

String (文字列)

ローカル商品オプション値の ID。

X

optionId

String (文字列)

ローカル商品オプションの ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Promotion

<commerce-cloud-dataapi:delete-promotion>

ID でプロモーションを削除します。 この操作では、​/pricing/promotions/{version}/organizations/{organizationId}/promotions/{id}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

id

String (文字列)

削除するプロモーションの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Source Code Group

<commerce-cloud-dataapi:delete-source-code-group>

ID でソースコードグループを削除します。 この操作では、/pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

id

String (文字列)

削除するソースコードグループの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Variation Attribute

<commerce-cloud-dataapi:delete-variation-attribute>

ID でバリエーション属性を削除します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{id}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品の ID。

X

id

String (文字列)

削除するバリエーション属性の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Delete Variation Attribute Value

<commerce-cloud-dataapi:delete-variation-attribute-value>

マスター商品にバインドされたバリエーション属性のバリエーション属性値を削除します。 この操作では、/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品の ID。

X

attributeId

String (文字列)

バリエーション属性 ID。

X

id

String (文字列)

バリエーション属性値の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Address For Customer From Customer List

<commerce-cloud-dataapi:get-address-for-customer-from-customer-list>

顧客リストから 1 つの顧客住所を返すアクション。 この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}/addresses/{addressId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

customerNo

String (文字列)

顧客番号。

X

listId

String (文字列)

顧客を返すリストのリスト ID。

X

limit (制限)

Integer (整数)

クエリパラメーター。要求ごとの最大取得レコード数。最小値は ​0​ です。

0

offset

Integer (整数)

クエリパラメーター。特定のリソースオフセットに基づいて結果を取得するために使用されます。最大値は ​50​ です。

25

addressId

String (文字列)

住所 ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Addresses For Customer From Customer List

<commerce-cloud-dataapi:get-addresses-for-customer-from-customer-list>

すべての顧客住所のページング可能なリストを返すアクション。デフォルトのページサイズは 10 件の顧客住所です。 この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}/addresses​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

customerNo

String (文字列)

顧客番号。

X

listId

String (文字列)

リスト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Assigned Product From Category

<commerce-cloud-dataapi:get-assigned-product-from-category>

カテゴリ商品割り当てを取得します。たとえば、商品 A、商品 B、商品 C の位置がそれぞれ 1、2、7.5 である場合、商品 B の割り当てを削除すると、商品 A と商品 C の位置が 1 つ上がり、7.5 が null のままになります。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

categoryId

String (文字列)

作成するカテゴリの ID。

X

productId

String (文字列)

割り当てるように要求された商品の ID (SKU)。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Campaign

<commerce-cloud-dataapi:get-campaign>

キャンペーン情報を取得するアクション。 この操作では、​/pricing/campaigns/{version}/organizations/{organizationId}/campaigns/{campaignId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

campaignId

String (文字列)

キャンペーンの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Catalog

<commerce-cloud-dataapi:get-catalog>

指定された情報でカタログを取得します。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Catalogs

<commerce-cloud-dataapi:get-catalogs>

絞り込みなしでカタログ ID のリストを取得するアクション。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

limit (制限)

Integer (整数)

クエリパラメーター。要求ごとの最大取得レコード数。最小値は 0 です。

0

offset

Integer (整数)

クエリパラメーター。特定のリソースオフセットに基づいて結果を取得するために使用されます。最大値は 50 です。

25

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Categories From Catalog

<commerce-cloud-dataapi:get-categories-from-catalog>

絞り込みなしですべてのカテゴリを取得するアクション。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

limit (制限)

Integer (整数)

クエリパラメーター。要求ごとの最大取得レコード数。最小値は 0 です。

0

offset

Integer (整数)

クエリパラメーター。特定のリソースオフセットに基づいて結果を取得するために使用されます。最大値は 50 です。

25

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Category From Catalog

<commerce-cloud-dataapi:get-category-from-catalog>

カタログ内の既存のカテゴリを読み取るアクション。

デフォルトでは、サーバーから第 1 レベルのサブカテゴリも返されますが、​levels​ パラメーターを設定して別のレベルを指定することもできます。​levels​ パラメーターに大きな値を使用する場合、カテゴリツリーが広く深いと、パフォーマンスの問題が発生する可能性があります。

この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

categoryId

String (文字列)

作成するカテゴリの ID。

X

levels (レベル)

Integer (整数)

レベル数のクエリパラメーター。最小値は 0 です。

0

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Coupon

<commerce-cloud-dataapi:get-coupon>

特定のクーポン ID のクーポン情報を返します。ユーザーロールに ​View_Coupon_Codes​ 権限がない場合、マスクされたクーポンコードが返されます。 この操作では、​/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

couponId

String (文字列)

クーポンの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Coupon Codes

<commerce-cloud-dataapi:get-coupon-codes>

特定のクーポンのクーポンコードを返します。ユーザーロールに ​View_Coupon_Codes​ 権限がない場合、マスクされたクーポンコードが返されます。 この操作では、​/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}/codes​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

couponId

String (文字列)

クーポンの ID。

X

limit (制限)

Integer (整数)

要求クエリパラメーターごとの最大取得レコード数。最小値は 0 です。

0

offset

Integer (整数)

特定のリソースオフセットに基づいて結果を取得するために使用されるクエリパラメーター。最大値は 50 です。

25

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Customer From Customer List

<commerce-cloud-dataapi:get-customer-from-customer-from-customer-list>

顧客情報を取得するアクション。 この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

listId

String (文字列)

リスト ID。

X

customerNo

String (文字列)

顧客番号。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Gift Certificate

<commerce-cloud-dataapi:get-gift-certificate>

販売店 ID を使用して、ギフト券情報を取得するアクション。 この操作では、​/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates/{merchantId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

merchantId

String (文字列)

要求されたギフト券の販売店 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Product

<commerce-cloud-dataapi:get-product>

商品情報を取得するアクション。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Product Option

<commerce-cloud-dataapi:get-product-option>

商品のローカルまたは共有商品オプションを読み取ります。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{id}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

id

String (文字列)

ローカルまたは共有商品オプションの ID。

X

currency (通貨)

String (文字列)

通貨のクエリパラメーター。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Product Option Value

<commerce-cloud-dataapi:get-product-option-value>

商品のローカル商品オプションのローカル商品オプション値を読み取ります。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{id}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

id

String (文字列)

ローカル商品オプション値の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Product Options

<commerce-cloud-dataapi:get-product-options>

商品のローカルおよび共有商品オプションを読み取ります。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

limit (制限)

Integer (整数)

要求ごとの最大取得レコード数のクエリパラメーター。最小値は 0 です。

0

offset

Integer (整数)

特定のリソースオフセットに基づいて結果を取得するために使用されるクエリパラメーター。最大値は 50 です。

25

currency (通貨)

String (文字列)

通貨のクエリパラメーター。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Promotion

<commerce-cloud-dataapi:get-promotion>

プロモーション情報を取得するアクション。 この操作では、​/pricing/promotions/{version}/organizations/{organizationId}/promotions/{id}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

id

String (文字列)

取得するプロモーションの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Source Code Group

<commerce-cloud-dataapi:get-source-code-group>

ソースコードグループ情報を取得するアクション。 この操作では、​/pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups/{id}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

id

String (文字列)

取得するソースコードグループの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Variation Attribute

<commerce-cloud-dataapi:get-variation-attribute>

マスター商品のバリエーション属性情報のみを取得するアクション。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{id}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品の ID。

X

id

String (文字列)

取得するバリエーション属性の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Variation Attribute Value

<commerce-cloud-dataapi:get-variation-attribute-value>

商品バリエーション属性値情報を取得するアクション。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{id}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品の ID。

X

id

String (文字列)

バリエーション属性値の ID。

X

attributeId

String (文字列)

バリエーション属性 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Variation Attributes

<commerce-cloud-dataapi:get-variation-attributes>

バリエーション種別、バリエーションマスター種別、バリエーショングループ種別の商品のバリエーション属性を読み取ります。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品の ID。

X

limit (制限)

Integer (整数)

要求ごとの最大取得レコード数のクエリパラメーター。最小値は 0 です。

0

offset

Integer (整数)

特定のリソースオフセットに基づいて結果を取得するために使用されるクエリパラメーター。最大値は 50 です。

25

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Variation For Master Product

<commerce-cloud-dataapi:get-variation-for-master-product>

商品マスターのバリエーションを読み取ります。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variations/{id}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

バリエーショングループが含まれるマスター商品の ID。

X

id

String (文字列)

バリエーション商品の ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Variation Group For Master Product

<commerce-cloud-dataapi:get-variation-group-for-master-product>

商品マスターのバリエーショングループを読み取ります。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variation-groups/{id}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

バリエーショングループが含まれるマスター商品の ID。

X

id

String (文字列)

バリエーショングループ商品の ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Variation Groups For Master Product

<commerce-cloud-dataapi:get-variation-groups-for-master-product>

商品マスターのバリエーショングループを読み取ります。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variation-groups​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

バリエーショングループが含まれるマスター商品の ID。

X

limit (制限)

Integer (整数)

要求ごとの最大取得レコード数のクエリパラメーター。最小値は 0 です。

0

offset

Integer (整数)

特定のリソースオフセットに基づいて結果を取得するために使用されるクエリパラメーター。最大値は 50 です。

25

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Variations For Master Product

<commerce-cloud-dataapi:get-variations-for-master-product>

商品マスターのバリエーションを読み取ります。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variations​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

バリエーショングループが含まれるマスター商品の ID。

X

limit (制限)

Integer (整数)

要求ごとの最大取得レコード数のクエリパラメーター。最小値は 0 です。

0

offset

Integer (整数)

特定のリソースオフセットに基づいて結果を取得するために使用されるクエリパラメーター。最大値は 50 です。

25

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Get Variations For Master Product

<commerce-cloud-dataapi:get-variations-for-master-product>

ギフト券を検索します。このクエリ属性では、検索を絞り込むために使用できる複雑なクエリを指定します。この操作では、​/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates​ エンドポイントに対する HTTP POST 要求を行います。

検索可能な属性のリストを次に示します。

属性 型 Sortable (並び替え可能)

merchantId

String (文字列)

はい

maskedGiftCertificateCode *

String (文字列)

no (いいえ)

orderNo

String (文字列)

はい

senderName

String (文字列)

はい

recipientName

String (文字列)

はい

recipientEmail

String (文字列)

はい

status (状況)

String (文字列)

はい

enabled (有効)

Boolean (ブール)

はい

メッセージ

String (文字列)

はい

description (説明)

String (文字列)

はい

creationDate

Date (日付)

はい

currencyMnemonic **

String (文字列)

はい

注意事項

  • maskedGiftCertificateCode​ (​code​ とも呼ばれる) は、用語クエリでのみ使用できます。
    4 文字のコードが指定された場合、コードのマスクされていない部分の検索であるとみなされます。それ以外の場合、すべてのコードが一致する必要があります。テキストクエリは使用できません。

  • currencyMnemonic​ は、論理積 (​AND​) を使用しないと他の属性と結合できません。

  • 並び替えには、検索可能な属性のみを使用できます。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Promotions Search

<commerce-cloud-dataapi:promotions-search>

プロモーションを検索します。SearchRequest ドキュメントには、さまざまな属性で絞り込むことができる検索オブジェクトが含まれます。

このクエリ属性では、次の検索可能な属性で検索を絞り込むために使用できる複雑なクエリを指定します。

属性 型

id

String (文字列)

name (名前)

String (文字列)

currecyCode

String (文字列)

exclusivity (排他性)

String (文字列)

enabled (有効)

Boolean (ブール)

並び替えに使用できるのは検索可能な属性のみで、次の属性を使用して並び替えることができます。

属性 型

promotionClass

String (文字列)

この操作では、​/pricing/promotions/{version}/organizations/{organizationId}/promotions​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Remove Address For Customer In Customer List

<commerce-cloud-dataapi:remove-address-for-customer-in-customer-list>

顧客住所を削除するアクション。 この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}/addresses/{addressId}​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

listId

String (文字列)

リスト ID。

X

addressId

String (文字列)

住所 ID。

X

customerNo

String (文字列)

顧客番号。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Search Catalogs

<commerce-cloud-dataapi:search-catalogs>

カタログを検索します。

このクエリ属性では、次の検索可能な属性で検索を絞り込むために使用できる複雑なクエリを指定します。

属性 型

id

String (文字列)

name (名前)

String (文字列)

description (説明)

String (文字列)

creationDate

DateTime

検索条件として使用できる 2 つの追加項目があります。これらは ​CatalogWO​ オブジェクトの属性ではありませんが、サイト割り当てに基づいてカタログを照会する検索条件として使用できます。

属性 型

isMasterCatalog

Boolean (ブール)

isStorefrontCatalog

Boolean (ブール)

description (説明)

String (文字列)

creationDate

DateTime (日時)

online (オンライン)

Boolean (ブール)

position (位置)

Double (倍精度浮動小数点数)

検索クエリで isMasterCatalog を使用すると、サイト割り当てのないカタログが返されます。検索クエリで isStorefrontCatalog を使用すると、1 つサイト割り当てのあるカタログが返されます。

クエリの出力は、次の並び替え可能な属性を使用して並び替えることもできます。

属性 型

id

String (文字列)

name (名前)

String (文字列)

description (説明)

String (文字列)

creationDate

DateTime

この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalog-search​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Search Categories

<commerce-cloud-dataapi:search-categories>

表示されるすべての場所でカタログカテゴリを検索します。デフォルトでは、サーバーから第 1 レベルのサブカテゴリも返されますが、levels パラメーターを設定して別のレベルを指定することもできます。levels に大きな値を使用すると、広く深いカテゴリツリーでパフォーマンスの問題が発生する可能性があります。 このクエリ属性では、次の検索可能な属性で検索を絞り込むために使用できる複雑なクエリを指定します。

属性 型

id

String (文字列)

name (名前)

String (文字列)

description (説明)

String (文字列)

creationDate

DateTime (日時)

online (オンライン)

Boolean (ブール)

catalogId

String (文字列)

クエリの出力は、次の並び替え可能な属性を使用して並び替えることもできます。

属性 型

id

String (文字列)

name (名前)

String (文字列)

description (説明)

String (文字列)

creationDate

DateTime (日時)

online (オンライン)

Boolean (ブール)

position (位置)

Double (倍精度浮動小数点数)

この操作では、​/product/catalogs/{version}/organizations/{organizationId}/category-search​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

levels (レベル)

Integer (整数)

レベル数。最小値は ​0​ です。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Search Categories In Catalog

<commerce-cloud-dataapi:search-categories-in-catalog>

カタログのスコープでカタログカテゴリを検索します。デフォルトでは、サーバーから第 1 レベルのサブカテゴリも返されますが、​levels​ パラメーターを設定して別のレベルを指定することもできます。​levels​ に大きな値を使用すると、広く深いカテゴリツリーでパフォーマンスの問題が発生する可能性があります。

このクエリ属性では、次の検索可能な属性で検索を絞り込むために使用できる複雑なクエリを指定します。

属性 型

id

String (文字列)

name (名前)

String (文字列)

description (説明)

String (文字列)

creationDate

DateTime (日時)

online (オンライン)

Boolean (ブール)

parentCategoryId

String (文字列)

クエリの出力は、次の並び替え可能な属性を使用して並び替えることもできます。

属性 型

id

String (文字列)

name (名前)

String (文字列)

description (説明)

String (文字列)

creationDate

DateTime (日時)

online (オンライン)

Boolean (ブール)

position (位置)

Double (倍精度浮動小数点数)

この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/category-search​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

levels (レベル)

Integer (整数)

レベル数。最小値は ​0​ です。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Search Customer In Customer List

<commerce-cloud-dataapi:search-customer-in-customer-list>

顧客リストの顧客を検索するアクション。

このクエリ属性では、検索を絞り込むために使用できる複雑なクエリを指定します。検索可能な属性のリストを次に示します。

属性 型

customerNo

String (文字列)

firstName

String (文字列)

secondName

String (文字列)

lastName

String (文字列)

suffix (サフィックス)

String (文字列)

salutation (敬称)

String (文字列)

title (タイトル)

String (文字列)

fax (ファックス)

String (文字列)

phoneHome

String (文字列)

phoneBusiness

String (文字列)

phoneMobile

String (文字列)

email (メール)

String (文字列)

gender (性別)

Integer (整数)

companyName

String (文字列)

credentials.login

String (文字列)

credentials.enabled

Boolean (ブール)

この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{customerListId}/customer-search​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

customerListId

String (文字列)

検索する顧客リスト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Search Product Variations

<commerce-cloud-dataapi:search-product-variations>

マスター商品またはバリエーショングループ商品の商品バリエーションを検索します。

このクエリ属性では、検索を絞り込むために使用できる複雑なクエリを指定します。検索可能な属性のリストには、以下が含まれます。

属性 型 Sortable (並び替え可能)

id

String (文字列)

はい

productId

String (文字列)

はい

name (名前)

String (文字列)

はい

online (オンライン)

SiteSpecific Boolean (サイト固有のブール)

はい

inStock

Boolean (ブール)

はい

searchable (検索可能)

SiteSpecific Boolean (サイト固有のブール)

はい

ats - 実際に販売可能な数量

Double (倍精度浮動小数点数)

はい
online​ および ​searchable​ の計算値は、検索と並び替えで使用されます。サイト固有の属性による検索または並び替えを行うには、サイト ID クエリパラメーターを設定する必要があります。サイト ID クエリパラメーターは次のとおりです。

  • online

  • inStock

  • searchable

  • ats

variationAttribute.​ で始まるすべての項目が検索可能で、ドットの後に「ATTRIBUTE_ID」が続くことを前提としています。

この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/variant-search​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Search Products

<commerce-cloud-dataapi:search-products>

商品を検索します。このクエリ属性では、検索を絞り込むために使用できる複雑なクエリを指定します。属性は、各種バケットにグループ化されます。

検索可能な属性のリストと対応するバケットを次に示します。

メイン:

属性 型

id

String (文字列)

name (名前)

String (文字列)

online (オンライン)

SiteSpecific Boolean (サイト固有のブール)

searchable (検索可能)

SiteSpecific Boolean (サイト固有のブール)

validFrom

SiteSpecific DateTime (サイト固有の日時)

validTo

SiteSpecific DateTime (サイト固有の日時)

型

ProductType

creationDate

DateTime

カタログ:

属性 型

catalogId

String (文字列)

カテゴリ:

属性 型 Sortable (並び替え可能)

並び替え可能なプロパティは次のとおりです。

属性 型 Sortable (並び替え可能)

id

String (文字列)

name (名前)

String (文字列)

creationDate

DateTime

この操作では、​/product/products/{version}/organizations/{organizationId}/product-search​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Search Products Assigned To Category

<commerce-cloud-dataapi:search-products-assigned-to-category>

カテゴリ商品割り当てを検索します。このクエリ属性では、検索を絞り込むために使用できる複雑なクエリを指定します。

検索可能な属性を次に示します。

属性 型

productId

String (文字列)

productName

String (文字列)

onlineFlag

Boolean (ブール)

searchable (検索可能)

Boolean (ブール)

validFrom

DateTime (日時)

validTo

DateTime (日時)

creationDate

DateTime

並び替え可能な項目:

属性 型

productId

String (文字列)

productName

String (文字列)

position (位置)

Double (倍精度浮動小数点数)

creationDate

DateTime

この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/category-product-assignment-search​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

categoryId

String (文字列)

カテゴリの ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Source Code Groups Search

<commerce-cloud-dataapi:source-code-groups-search>

ソースコードグループを検索します。

このクエリ属性では、次の検索可能な属性で検索を絞り込むために使用できる複雑なクエリを指定します。

属性 型

id

String (文字列)

description (説明)

String (文字列)

sourceCode

String (文字列)

startTime

DateTime (日時)

endTime

DateTime (日時)

creationDate

DateTime (日時)

enabled (有効)

Boolean (ブール)

active (アクティブ)

Boolean (ブール)

クエリで ​sourceCode​ 項目と ​active​ 項目を使用するには、論理積 (​AND​) を使用する必要があります。項目が論理和 (​OR​) で使用されている場合、例外がスローされます。

クエリの出力は、次の並び替え可能な属性を使用して並び替えることもできます。

属性 型

id

String (文字列)

description (説明)

String (文字列)

enabled (有効)

Boolean (ブール)

creationDate

DateTime

この操作では、​/pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

version (バージョン)

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

categoryId

String (文字列)

カテゴリの ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Unassign Product From Category

<commerce-cloud-dataapi:unassign-product-from-category>

カテゴリ商品割り当てを削除します。

たとえば、商品 A、商品 B、商品 C の位置がそれぞれ 1、2、7.5 である場合、商品 B の割り当てを削除すると、商品 A と商品 C の位置が 1 つ上がり、7.5 が null のままになります。

この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

categoryId

String (文字列)

カテゴリの ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

productId

String (文字列)

割り当てるように要求された商品の ID (SKU)。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Unassign Variation From Master Product

<commerce-cloud-dataapi:unassign-variation-from-master-product>

商品マスターからバリエーション商品の割り当てを解除します。バリエーション商品自体は削除されません。商品マスターから割り当てを解除された後も通常の商品として残ります。

この操作では、​/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variations/{id}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

バリエーショングループが含まれるマスター商品の ID。

X

id

String (文字列)

バリエーション商品の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Unassign Variation Group From Master Product

<commerce-cloud-dataapi:unassign-variation-group-from-master-product>

商品マスターのバリエーショングループ商品の割り当てを解除します。バリエーショングループ商品自体は削除されません。商品マスターから割り当てを解除された後も通常の商品として残ります。

この操作では、​/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variation-groups/{id}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

バリエーショングループが含まれるマスター商品の ID。

X

id

String (文字列)

バリエーショングループ商品の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Address For Customer In Customer List

<commerce-cloud-dataapi:update-address-for-customer-in-customer-list>

特定の住所情報で顧客の住所を更新するアクション。 この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}/addresses/{addressId}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

listId

String (文字列)

更新する顧客住所が含まれるリストの ID。

X

addressId

String (文字列)

顧客住所 ID。

X

customerNo

String (文字列)

顧客番号。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Campaign

<commerce-cloud-dataapi:update-campaign>

指定された情報でキャンペーンを更新します。 この操作では、​/pricing/campaigns/{version}/organizations/{organizationId}/campaigns/{campaignId}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

campaignId

String (文字列)

キャンペーンの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Catalog

<commerce-cloud-dataapi:update-catalog>

指定された情報でカタログを更新します。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Category In Catalog

<commerce-cloud-dataapi:update-category-in-catalog>

指定された情報を使用して、カタログカテゴリを更新します。 この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

categoryId

String (文字列)

更新するカテゴリの ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Coupon

<commerce-cloud-dataapi:update-coupon>

指定された情報でクーポンを更新します。 この操作では、​/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

couponId

String (文字列)

更新するクーポンの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Coupon Codes

<commerce-cloud-dataapi:update-coupon-codes>

指定されたクーポンの複数のコードを追加または削除 (変更) します。 この操作では、​/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}/codes​ エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

couponId

String (文字列)

更新するクーポンの ID

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Customer In Customer List

<commerce-cloud-dataapi:update-customer-in-customer-list>

指定された情報で顧客を更新します。顧客番号は更新できますが、同じ顧客番号の既存の顧客がいる場合、​CustomerNumberAlreadyInUseException​ が発生します。

この操作では、​/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

listId

String (文字列)

顧客が属するリストのリスト ID。

X

customerNo

String (文字列)

顧客番号。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Gift Certificate

<commerce-cloud-dataapi:update-gift-certificate>

販売店 ID を使用して、指定された情報でギフト券を更新します。 この操作では、​/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates/{merchantId}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

merchantId

String (文字列)

要求されたギフト券の販売店 ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order

<commerce-cloud-dataapi:update-order>

注文を更新します。 この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order Confirmation Status

<commerce-cloud-dataapi:update-order-confirmation-status>

注文確認の状況を更新します。 この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/confirmation-status​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order Export Status

<commerce-cloud-dataapi:update-order-export-status>

注文出庫状況を更新します。状況を ​EXPORTED​ に設定すると、この注文の [on-order (注文中)] の在庫トランザクションの最終処理がトリガーされます。つまり、[on-order (注文中)] 種別のすべての在庫トランザクションが最終在庫トランザクションに移動します。これは、注文した商品が含まる在庫リストで [on-order (注文中)] 在庫が有効になっている場合にのみ関連します。

この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/export-status​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order External Status

<commerce-cloud-dataapi:update-order-external-status>

注文外部状況を更新します。 この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/external-status​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order Payment Instrument

<commerce-cloud-dataapi:update-order-payment-instrument>

注文支払手段を更新します。 この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

paymentInstrumentId

String (文字列)

支払手段の ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order Payment Status

<commerce-cloud-dataapi:update-order-payment-status>

注文支払状況を更新します。 この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-status​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order Payment Transaction

<commerce-cloud-dataapi:update-order-payment-transaction>

注文支払手段のトランザクションを更新します。 この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}/transaction​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

paymentInstrumentId

String (文字列)

支払手段の ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order Shipping Address

<commerce-cloud-dataapi:update-order-shipping-address>

注文出荷住所を更新 (作成または置換) します。 この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/shipments/{shipmentId}/shipping-address​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

shipmentId

String (文字列)

出荷の ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order Shipping Status

<commerce-cloud-dataapi:update-order-shipping-status>

注文出荷状況を更新します。 この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/shipping-status​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Order Status

<commerce-cloud-dataapi:update-order-status>

注文状況を更新します。[NEW (新規)]、[COMPLETED (完了)]、[CANCELLED (キャンセル)] の状況の注文は、[CREATED (作成済み)] または [FAILED (失敗)] の状況に設定できません。 この操作では、​/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/status​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

orderNo

String (文字列)

注文番号。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Product

<commerce-cloud-dataapi:update-product>

指定された情報を使用して、商品を更新します。

更新できる項目は次のとおりです。

  • name (名前)

  • pageDescription

  • longDescripton

  • pageTitle

  • pageKeywords

  • brand

  • ean

  • upc

  • manufactureSku

  • manufactureName

  • searchable (検索可能)

  • unit

  • onlineFlag

  • defaultVariantId

この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品 ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Product Category Assignment

<commerce-cloud-dataapi:update-product-category-assignment>

指定された情報 (位置など) でカテゴリ商品割り当てを更新します。割り当てられる位置は、正規化された対象位置であるため、位置の順序が保持されたまま商品が特定の位置に割り当てられます。

たとえば、商品 A、商品 B、商品 C、商品 D の位置がそれぞれ 1、2、3、4 である場合、商品 A を新しい位置 3 で更新すると、次のような結果になります。

商品

位置

B

1

C

2

A

3

D

4

商品 C を位置なしに更新すると、次のような結果になります。

商品

位置

B

1

A

2

D

3

C

null

n 個の既存の位置の割り当てが存在する場合、商品を位置 >= n に更新すると、各位置の順序が保持されるような位置で新しい割り当てが行われます。

この操作では、​/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

catalogId

String (文字列)

要求されたカタログの ID。

X

categoryId

String (文字列)

更新するカテゴリの ID。

X

productId

String (文字列)

割り当てるように要求された商品の ID (SKU)。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Product Option

<commerce-cloud-dataapi:update-product-option>

指定された情報でローカル商品オプション値を更新します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{id}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productId

String (文字列)

商品の ID。

X

id

String (文字列)

ローカルまたは共有商品オプションの ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Product Option value

<commerce-cloud-dataapi:update-product-option-value>

指定された情報でローカル商品オプション値を更新します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{id}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

optionId

String (文字列)

ローカル商品オプションの ID。

X

productId

String (文字列)

商品の ID。

X

id

String (文字列)

ローカル商品オプション値の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Promotion

<commerce-cloud-dataapi:update-promotion>

指定された情報でプロモーションを更新します。 この操作では、​/pricing/promotions/{version}/organizations/{organizationId}/promotions/{id}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

id

String (文字列)

更新するプロモーションの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Source Code Group

<commerce-cloud-dataapi:update-source-code-group>

指定された情報でソースコードグループを更新します。 この操作では、​/pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups/{id}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

id

String (文字列)

更新するソースコードグループの ID。

X

siteId

String (文字列)

特定のサイトのデータを照会するクエリパラメーターとして使用されるサイト ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Variation Attribute

<commerce-cloud-dataapi:update-variation-attribute>

指定された情報でバリエーション属性を更新します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{id}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productid

String (文字列)

商品の ID。

X

id

String (文字列)

更新するバリエーション属性の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Variation Attribute Value

<commerce-cloud-dataapi:update-variation-attribute-value>

マスター商品にバリエーション属性のバリエーション属性値を更新します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{id}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

productid

String (文字列)

商品の ID。

X

id

String (文字列)

バリエーション属性値の ID。

X

attributeId

String (文字列)

バリエーション属性 ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Variation For Master Product

<commerce-cloud-dataapi:update-variation-for-master-product>

商品マスターのバリエーションを更新します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variations/{id}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

バリエーショングループが含まれるマスター商品の ID。

X

id

String (文字列)

バリエーション商品の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Update Variation Group For Master Product

<commerce-cloud-dataapi:update-variation-group-for-master-product>

商品マスターのバリエーショングループを更新します。 この操作では、​/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variation-groups/{id}​ エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

X

version

String (文字列)

API バージョン。

X

organizationId

String (文字列)

組織 ID。

X

masterProductId

String (文字列)

バリエーショングループが含まれるマスター商品の ID。

X

id

String (文字列)

バリエーショングループ商品の ID。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

X

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

Configurations (設定)

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

Unauthorize

<commerce-cloud-dataapi:unauthorize>

特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスが繰り返されない限り、そのユーザー向けの操作を実行できないようにします。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

次の設定の場合

スロー

  • DATA:BAD_REQUEST​

  • DATA:CLIENT_ERROR​

  • DATA:CONNECTIVITY

  • DATA:INTERNAL_SERVER_ERROR​

  • DATA:NOT_ACCEPTABLE​

  • DATA:NOT_FOUND​

  • DATA:RETRY_EXHAUSTED​

  • DATA:SERVER_ERROR​

  • DATA:SERVICE_UNAVAILABLE​

  • DATA:TIMEOUT

  • DATA:TOO_MANY_REQUESTS​

  • DATA:UNAUTHORIZED

  • DATA:UNSUPPORTED_MEDIA_TYPE​

型

Default Header (デフォルトヘッダー)

項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

Default Query Param (デフォルトクエリパラメーター)

項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

Proxy (プロキシ)

項目 型 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

x

Port (ポート)

Number (数値)

x

Username (ユーザー名)

String (文字列)

Password (パスワード)

String (文字列)

Non Proxy Hosts (非プロキシホスト)

String (文字列)

TLS

項目 型 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

トラストストア

Key Store (キーストア)

Key Store (キーストア)

Revocation Check (取り消し確認)

トラストストア

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するトラストストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が行われず、攻撃に対して脆弱な接続がレンダリングされます。各自の責任で使用してください。

Key Store (キーストア)

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するキーストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用するキーの別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 型 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

OCSP ではなく CRL を最初に試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

項目 型 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

ReconnectForever

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Expiration Policy (有効期限ポリシー)

項目 型 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位。

HTTP Response Attributes (HTTP 応答属性)

項目 型 説明 デフォルト値 必須

Status Code (状況コード)

Number (数値)

x

Headers (ヘッダー)

Object (オブジェクト)

x

Reason Phrase (理由を示す語句)

String (文字列)

x

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームしてランダムにアクセスするために割り当てられるメモリ量。このバッファに収めることができる量よりも多くのデータがストリームに含まれる場合、バッファは、bufferSizeIncrement 属性に従って maxInMemorySize の上限まで拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 または負の値に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。指定されたサイズ値を超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらのすべての属性の単位

Repeatable File Store Stream (反復可能なファイルストアストリーム)

項目 型 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームを使用し、ランダムアクセスを提供するために初期状態でメモリ内に保持が許容されるインスタンス数。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。

100

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期指定サイズを超えた場合に、どれだけ拡張するか。値を 0 または負の値に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

100

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。指定されたサイズ値を超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目 型 説明 デフォルト値 必須

In Memory Objects (メモリ内オブジェクト)

Number (数値)

メモリに保持するインスタンスの最大数。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

関連情報