Commerce Cloud B2C Shop Connector 2.1 リファレンス - Mule 4

制限事項

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

Am Oauth2 設定

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

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

名前	型	説明	デフォルト値	必須
Name (名前)	String (文字列)	この設定の名前。コネクタはこの名前の設定を参照します。		x
Connection (接続)	Shop Account Manager Oauth2 Connection Provider (Shop Account Manager Oauth2 接続プロバイダー)	この設定に指定できる接続種別。		x
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。	1
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。	MINUTES (分)
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。	AUTO
Name (名前)	String (文字列)	他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。		x
Expiration Policy (有効期限ポリシー)	Expiration Policy (有効期限ポリシー)	動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。

Name (名前)

String (文字列)

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

x

Connection (接続)

Shop Account Manager Oauth2 Connection Provider (Shop Account Manager Oauth2 接続プロバイダー)

この設定に指定できる接続種別。

x

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

Number (数値)

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

1

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

MINUTES (分)

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

AUTO

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

x

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

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

接続種別

Shop Account Manager Oauth2 Connection Provider (Shop Account Manager Oauth2 接続プロバイダー)

パラメーター

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

名前	型	説明	デフォルト値
Default Headers (デフォルトヘッダー)	Default Header (デフォルトヘッダー) の配列
Query Parameters (クエリパラメーター)	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 (日)	Connection Idle Timeout (接続アイドルタイムアウト) の時間単位。	SECONDS (秒)
Proxy Config (プロキシ設定)	Proxy (プロキシ)	プロキシ経由のアウトバウンド接続の再利用可能な設定要素。
Stream Response (応答のストリーミング)	Boolean (ブール)	受信した応答ストリーミングするかどうか。	false
Response Buffer Size (応答バッファサイズ)	Number (数値)	HTTP 応答が保存されるバッファの領域 (バイト)。	-1
Base Uri (ベース URI)	String (文字列)	各インスタンスまたはテナントが独自のベース URI を取得します。	`https://{shortCode}.api.commercecloud.salesforce.com`
TLS Configuration (TLS 設定)	TLS
Reconnection (再接続)	Reconnection (再接続)	アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

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

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

Query Parameters (クエリパラメーター)

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 (日)

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

SECONDS (秒)

Proxy Config (プロキシ設定)

Proxy (プロキシ)

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

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

Boolean (ブール)

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

false

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

Number (数値)

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

-1

Base Uri (ベース URI)

String (文字列)

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

https://{shortCode}.api.commercecloud.salesforce.com

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

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

顧客認証設定

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

名前	型	説明	デフォルト値	必須
Name (名前)	String (文字列)	この設定の名前。コネクタはこの名前の設定を参照します。		x
Connection (接続)	Shopper Connection Provider (Shopper 接続プロバイダー)	この設定に指定できる接続種別。		x
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。	1
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。	MINUTES (分)
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。	AUTO
Name (名前)	String (文字列)	他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。		x
Expiration Policy (有効期限ポリシー)	Expiration Policy (有効期限ポリシー)	動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、対象になった瞬間にプラットフォームでインスタンスの有効期限が切れるという意味ではありません。ランタイムによって適切と判断されたときに、インスタンスが実際にパージされます。

Name (名前)

String (文字列)

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

x

Connection (接続)

Shopper Connection Provider (Shopper 接続プロバイダー)

この設定に指定できる接続種別。

x

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

Number (数値)

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

1

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

MINUTES (分)

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

AUTO

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

x

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、対象になった瞬間にプラットフォームでインスタンスの有効期限が切れるという意味ではありません。ランタイムによって適切と判断されたときに、インスタンスが実際にパージされます。

接続種別

Shopper Connection Provider (Shopper 接続プロバイダー)

パラメーター

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

名前	型	説明	デフォルト値	必須
Default Headers (デフォルトヘッダー)	Default Header (デフォルトヘッダー) の配列
Query Parameters (クエリパラメーター)	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 (日)	Connection Idle Timeout (接続アイドルタイムアウト) の時間単位。	SECONDS (秒)
Proxy Config (プロキシ設定)	Proxy (プロキシ)	プロキシ経由のアウトバウンド接続の再利用可能な設定要素。
Stream Response (応答のストリーミング)	Boolean (ブール)	受信応答をストリーミングする必要があるかどうか。	false
Response Buffer Size (応答バッファサイズ)	Number (数値)	HTTP 応答が保存されるバッファの容量 (バイト)。	-1
Base Uri (ベース URI)	String (文字列)	各インスタンスまたはテナントが独自のベース URI を取得します。	`https://{shortCode}.api.commercecloud.salesforce.com`
Authorization (認証)	String (文字列)	Shopper JWT トークン		x
TLS Configuration (TLS 設定)	TLS
Reconnection (再接続)	Reconnection (再接続)	アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

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

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

Query Parameters (クエリパラメーター)

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 (日)

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

SECONDS (秒)

Proxy Config (プロキシ設定)

Proxy (プロキシ)

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

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

Boolean (ブール)

受信応答をストリーミングする必要があるかどうか。

false

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

Number (数値)

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

-1

Base Uri (ベース URI)

String (文字列)

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

https://{shortCode}.api.commercecloud.salesforce.com

Authorization (認証)

String (文字列)

Shopper JWT トークン

x

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

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

Shopper トークン設定

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

名前	型	説明	デフォルト値	必須
Name (名前)	String (文字列)	この設定の名前。コネクタはこの名前の設定を参照します。		x
Connection (接続)	Shopper Token Connection Provider (Shopper トークン接続プロバイダー)	この設定に指定できる接続種別。		x
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。	1
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。	MINUTES (分)
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。	AUTO
Name (名前)	String (文字列)	他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。		x
Expiration Policy (有効期限ポリシー)	Expiration Policy (有効期限ポリシー)	動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、対象になった瞬間にプラットフォームでインスタンスの有効期限が切れるという意味ではありません。ランタイムによって適切と判断されたときに、インスタンスが実際にパージされます。

Name (名前)

String (文字列)

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

x

Connection (接続)

Shopper Token Connection Provider (Shopper トークン接続プロバイダー)

この設定に指定できる接続種別。

x

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

Number (数値)

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

1

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

MINUTES (分)

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

AUTO

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

x

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、対象になった瞬間にプラットフォームでインスタンスの有効期限が切れるという意味ではありません。ランタイムによって適切と判断されたときに、インスタンスが実際にパージされます。

接続種別

Shopper Token Connection Provider (Shopper トークン接続プロバイダー)

パラメーター

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

名前	型	説明	デフォルト値
Default Headers (デフォルトヘッダー)	Default Header (デフォルトヘッダー) の配列
Query Parameters (クエリパラメーター)	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 (日)	Connection Idle Timeout (接続アイドルタイムアウト) の時間単位。	SECONDS (秒)
Proxy Config (プロキシ設定)	Proxy (プロキシ)	プロキシ経由のアウトバウンド接続の再利用可能な設定要素。
Stream Response (応答のストリーミング)	Boolean (ブール)	受信応答をストリーミングする必要があるかどうか。	false
Response Buffer Size (応答バッファサイズ)	Number (数値)	HTTP 応答が保存されるバッファの領域 (バイト)。	-1
Base Uri (ベース URI)	String (文字列)	各インスタンスまたはテナントが独自のベース URI を取得します。	`https://{shortCode}.api.commercecloud.salesforce.com`
TLS Configuration (TLS 設定)	TLS
Reconnection (再接続)	Reconnection (再接続)	アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

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

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

Query Parameters (クエリパラメーター)

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 (日)

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

SECONDS (秒)

Proxy Config (プロキシ設定)

Proxy (プロキシ)

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

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

Boolean (ブール)

受信応答をストリーミングする必要があるかどうか。

false

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

Number (数値)

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

-1

Base Uri (ベース URI)

String (文字列)

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

https://{shortCode}.api.commercecloud.salesforce.com

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

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

操作

Get Reset Password Token

<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-password-actions-create-reset-token-by-version-organization-id>

パスワードのリセットトークンを取得します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/create-reset-token エンドポイントに HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Am Oauth2 設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Reset Password

<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-password-actions-reset-by-version-organization-id>

顧客のパスワードをリセットします。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/reset エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Am Oauth2 設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Authorize Trusted System

<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-trusted-system-actions-login-by-version-organization-id>

サードパーティシステムを使用して、ログイン情報が保存されている登録顧客の JSON Web トークン (JWT) を取得します。loginId と clientId を受け入れ、レスポンスボディで顧客オブジェクトを返し、レスポンスヘッダーで clientId に対して生成された JWT を返します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/trusted-system/actions/login エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ。	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Am Oauth2 設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Price Books For Basket

<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-price-books-by-version-organization-id-basket-id>

既存のバスケットに適用可能な価格表を取得します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/price-books エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。	#[null]
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Am Oauth2 設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Taxes From Basket

<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-taxes-by-version-organization-id-basket-id>

このメソッドは、PUT taxes API によって設定された外部課税データを提供します。このエンドポイントは、バスケットの作成で外部課税モードが使用されていた場合にのみコールできます。詳細は、「POST /baskets」を参照してください。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/taxes エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。	#[null]
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Am Oauth2 設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Taxes From Order

<commerce-cloud-shopper-api:get-checkout-shopper-orders-organizations-orders-taxes-by-version-organization-id-order-no>

このメソッドは、注文の作成中にバスケットから転送された注文の外部課税データを提供します。このエンドポイントは、外部課税が使用されていた場合にのみコールできます。詳細は、「POST /baskets」を参照してください。この操作では、/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/taxes エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Order No (注文番号)	String (文字列)	変更する注文の注文番号。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。	#[null]
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Order No (注文番号)

String (文字列)

変更する注文の注文番号。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Am Oauth2 設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Add Taxes For Basket Item

<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-items-taxes-by-version-organization-id-basket-id-item-id>

このメソッドを使用すると、外部の課税データを既存のバスケットに適用して、特定の課税品目の税率と省略可能な値を渡すことができます。このエンドポイントは、バスケットの作成で外部課税モードが使用されていた場合にのみコールできます。詳細は、「POST /baskets」を参照してください。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId}/taxes エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Item Id (品目 ID)	String (文字列)	更新する品目の ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。	#[null]
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Item Id (品目 ID)

String (文字列)

更新する品目の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Am Oauth2 設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Add Price Books To Basket

<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-price-books-by-version-organization-id-basket-id>

このメソッドを使用すると、priceBookId の配列を既存のバスケットに配置できます。これは、バスケットの計算に使用されます。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/price-books エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Am Oauth2 設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Add Taxes For Basket

<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-taxes-by-version-organization-id-basket-id>

このメソッドを使用すると、外部の課税データを既存のバスケットに適用して、すべての課税品目の税率と省略可能な値を渡すことができます。このエンドポイントは、バスケットの作成で外部課税モードが使用されていた場合にのみコールできます。詳細は、「POST /baskets」を参照してください。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/taxes エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Am Oauth2 設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Create Basket

<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-by-version-organization-id>

新しいバスケットを作成します。作成されたバスケットは、デフォルト値で初期化されます。本文ドキュメントで指定されたデータが、作成されたバスケットに入力されます。これは、下記の API エンドポイントで更新できます。taxMode クエリパラメーターを使用して、バスケットの税金モードを選択できます。デフォルトは内部課税モードで、内部税金テーブルに基づいて税金が自動的に計算されます。または、外部課税モードを設定して、税率や税額を手動で変更することもできます。外部税金データは、商品品目、オプション品目、配送品目、クーポン品目、ボーナス割引品目で必須です。ギフト券品目は省略可能です。デフォルトでは税率 0 が使用されますが、上書きすることができます。価格調整は、計算または継承されるため設定できません。税率は、種別に応じて、関連する品目から取得されるか、バスケットの按分として計算されます。次の API エンドポイントを使用すると、バスケットをさらに変更できます。- 顧客情報: PUT /baskets/{basketId}/customer - 請求先住所: PUT /baskets/{basketId}/billing-address - 出荷 (配送先住所や配送方法など): POST /baskets/{basketId}/shipments - 商品品目: POST /baskets/{basketId}/items - クーポン品目: POST /baskets/{basketId}/coupons - ギフト券品目: POST /baskets/{basketId}/gift-certificates - バスケットの課税: PUT /baskets/{basketId}/taxes - バスケットの品目の課税: PUT /baskets/{basketId}/items/{itemId}/taxes - 支払方法とカードの種類: POST /baskets/{basketId}/payment-instruments - カスタムプロパティ: PATCH /baskets/{basketId} 関連リソースを使用すると、バスケットの作成後に同じデータを指定できます。basketId プロパティを使用してバスケットを識別します。このプロパティは、更新要求のパスに統合されます (例: /baskets/{basketId}/items に対する POST)。顧客は、1 人の顧客 (ゲスト顧客または登録顧客) を指定する JSON Web トークン (JWT) を提供する必要があります。このケースでは、リソースでこの顧客のバスケットを作成します。顧客ごとに作成できるバスケットの数は制限されています。バスケットが作成されると、開いた状態になります。これは、リソース /orders に対する POST を使用してバスケットから注文が作成されるか、リソース /baskets/{basketId} に対する DELETE を使用して注文が削除されるまで開いたままになります。開いたバスケットは、顧客ごとに 1 つのみ設定できます。c_<CUSTOM_NAME> の形式のカスタムプロパティがサポートされています。カスタムプロパティは、バスケットシステムオブジェクトで定義されたカスタム属性 (<CUSTOM_NAME>) に対応している必要があります。また、その値はそのカスタム属性で有効であることが必要です。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Tax Mode (税金モード)	Enumeration (列挙)。次のいずれかになります。 INTERNAL EXTERNAL (外部)	Tax Mode (税金モード)	INTERNAL
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Tax Mode (税金モード)

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

INTERNAL
EXTERNAL (外部)

Tax Mode (税金モード)

INTERNAL

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Add Coupon To Basket

<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-coupons-by-version-organization-id-basket-id>

既存のバスケットにクーポンを追加します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/coupons エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Add Gift Certificate Item To Basket

<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-gift-certificate-items-by-version-organization-id-basket-id>

既存のバスケットにギフト券品目を追加します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Add Item To Basket

<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-items-by-version-organization-id-basket-id>

バスケットに新規品目を追加します。追加された品目は、指定された出荷に関連付けられます。出荷 ID が指定されていない場合、追加された品目はデフォルトの出荷に関連付けられます。各品目のリクエストボディで考慮される値は次のとおりです。- productId: 有効な商品 ID。これは、バスケットに追加される商品の ID です。商品がすでにバスケットにある場合、API はサイト設定 [Add Product Behavior (商品の追加動作)] に基づいて、既存の商品品目の数量を増やすか、新しい商品品目を作成します。ベース商品が含まれるオプション商品や商品バンドルの場合、API はサイト設定に関係なく新しい商品品目を作成します。- shipmentId: 有効な出荷 ID (省略可能)。これは、商品品目が作成される出荷の ID です。- quantity: 0.01 ～ 999 の数値。これは、注文する商品の数量です。- inventoryId: 有効な在庫 ID (省略可能)。これは、品目の割り当て元の在庫の ID です。- bonusDiscountLineItemId: 有効なボーナス割引品目 ID (省略可能)。これは、追加された商品がボーナス割引品目に選択されたボーナス商品である場合のボーナス割引品目の ID です。- optionItems/optionValueId: 有効なオプション値 ID。これは、オプション商品のオプション品目のオプション値です。これは、商品品目がオプション商品の場合にのみ可能です。オプション値を設定するには、optionItems プロパティでオプション品目のコレクションを指定する必要があります。これらのオプション品目には、optionId と optionValueId が含まれている必要があります。また、この商品品目が表すオプション商品で有効な値を指定する必要があります。指定しない場合、サーバーで InvalidProductOptionItemException または InvalidProductOptionValueItemException がスローされます。- c_<CUSTOM_NAME>: 形式のカスタムプロパティ: カスタムプロパティは、ProductLineItem で定義されたカスタム属性 (<CUSTOM_NAME>) に対応している必要があります。プロパティの値は、ProductLineItem で定義されたカスタム属性の型で有効である必要があります。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Add Payment Instrument To Basket

<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-payment-instruments-by-version-organization-id-basket-id>

バスケットに支払手段を追加します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-instruments エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Create Shipment For Basket

<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-shipments-by-version-organization-id-basket-id>

バスケットの新しい出荷を作成します。作成された出荷は、本文ドキュメントで指定された値で初期化され、後続のデータ API コールで更新できます。本文でプロパティ (ID、配送先住所、配送北条、ギフトのブールフラグ、ギフトメッセージ、カスタムプロパティ) が指定されている場合は考慮します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Basket Id (バスケット ID)	String (文字列)	変更するバスケットの ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Create Order

<commerce-cloud-shopper-api:create-checkout-shopper-orders-organizations-orders-by-version-organization-id>

準備されたバスケットに基づいて注文を送信します。リクエストボディで考慮される唯一の値は basketId です。この操作では、/checkout/shopper-orders/{version}/organizations/{organizationId}/orders エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Create Payment Instrument For Order

<commerce-cloud-shopper-api:create-checkout-shopper-orders-organizations-orders-payment-instruments-by-version-organization-id-order-no>

注文に支払手段を追加します。詳細: 支払手段は、指定された詳細で追加されます。支払方法は注文に該当している必要があります。「GET /baskets/{basketId}/payment-methods」を参照してください。支払方法が「CREDIT_CARD」の場合、要求で paymentCard を指定する必要があります。この操作では、/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Order No (注文番号)	String (文字列)	変更する注文の注文番号。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Order No (注文番号)

String (文字列)

変更する注文の注文番号。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Create Customer Address

<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id>

指定された顧客の指定された名前で新しい住所を作成します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Customer Id (顧客 ID)	String (文字列)	顧客 ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Register Customer

<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-by-version-organization-id>

新規顧客を登録します。必須データは、ログイン情報、プロファイルの姓、メールです。これには、種別「guest」で POST /customers/auth API を使用して取得する必要がある JSON Web トークン (JWT) が必要です。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Create Customer Payment Instrument

<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-payment-instruments-by-version-organization-id-customer-id>

顧客情報に支払手段を追加します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Customer Id (顧客 ID)	String (文字列)	顧客 ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Create Customer Product List

<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id>

顧客商品リストを作成します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Customer Id (顧客 ID)	String (文字列)	顧客 ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Create Customer Product List Item

<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id>

顧客の商品リストに品目を追加します。リクエストボディで考慮される値は次のとおりです。type: 有効な型、必須。これは、顧客の商品リストに追加される品目の種別です。public: これは、顧客の商品リストに追加される品目が公開されるのかどうかを示すフラグです。product_id: 有効な商品 ID。商品品目種別でのみ使用されます。これは、顧客の商品リストに追加される品目に関連する商品の ID (SKU) です。これは、商品品目種別に必須で、有効な商品 ID である必要があります。そうでない場合、ProductListProductIdMissingException または ProductListProductNotFoundException がスローされます。quantity: 商品品目種別でのみ使用します。これは、顧客の商品リストに追加される品目の数量です。 c_<CUSTOM_NAME> 形式のカスタムプロパティ: カスタムプロパティは、ProductListItem で定義されたカスタム属性 (<CUSTOM_NAME>) に対応している必要があります。プロパティの値は、ProductListItem で定義されたカスタム属性の型で有効である必要があります。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
version	String (文字列)	version		x
Organization Id (組織 ID)	String (文字列)	Organization Id (組織 ID)		x
Customer Id (顧客 ID)	String (文字列)	顧客 ID。		x
List Id (リスト ID)	String (文字列)	商品リスト ID。		x
Site Id (サイト ID)	String (文字列)	Site Id (サイト ID)		x
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。		x
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)	要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。
Custom Headers (カスタムヘッダー)	Object (オブジェクト)	要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	ストリーミングを使用して要求を送信するかどうかを定義します。値が `AUTO` に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Gift Certificate

<commerce-cloud-shopper-api:create-pricing-shopper-gift-certificates-organizations-gift-certificate-by-version-organization-id>

既存のギフト券を取得するアクション。この操作では、/pricing/shopper-gift-certificates/{version}/organizations/{organizationId}/gift-certificate エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Delete Basket

<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>

バスケットを削除します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Remove Coupon From Basket

<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-coupons-by-version-organization-id-basket-id-coupon-item-id>

バスケットからクーポンを削除します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/coupons/{couponItemId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Coupon Item Id (クーポン品目 ID)

String (文字列)

削除するクーポン品目の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Remove Gift Certificate Item From Basket

<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-gift-certificate-items-by-version-organization-id-basket-id-gift-certificate-item-id>

既存のバスケットからギフト券品目を削除します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Gift Certificate Item Id (ギフト券品目 ID)

String (文字列)

更新するギフト券品目の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Remove Item From Basket

<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-items-by-version-organization-id-basket-id-item-id>

バスケットから商品品目を削除します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Item Id (品目 ID)

String (文字列)

更新する品目の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Remove Payment Instrument From Basket

<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-payment-instruments-by-version-organization-id-basket-id-payment-instrument-id>

バスケットの支払手段を削除します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-instruments/{paymentInstrumentId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Payment Instrument Id (支払手段 ID)

String (文字列)

Payment Instrument Id (支払手段 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Remove Shipment From Basket

<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-shipments-by-version-organization-id-basket-id-shipment-id>

指定された出荷、関連するすべての商品、ギフト券、配送、価格調整品目をバスケットから削除します。デフォルトの出荷は削除できません。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Remove Payment Instrument From Order

<commerce-cloud-shopper-api:delete-checkout-shopper-orders-organizations-orders-payment-instruments-by-version-organization-id-order-no-payment-instrument-id>

注文の支払手段を削除します。この操作では、/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Order No (注文番号)

String (文字列)

変更する注文の注文番号。

x

Payment Instrument Id (支払手段 ID)

String (文字列)

更新する支払手段の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Invalidate Customer Auth

<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-actions-logout-by-version-organization-id>

ヘッダーで提供される JSON Web トークン (JWT) を無効にします。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/logout エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Remove Customer Address

<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id-address-name>

住所名で顧客の住所を削除します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Address Name (住所名)

String (文字列)

更新する住所の名前。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Delete Customer Payment Instrument

<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-payment-instruments-by-version-organization-id-customer-id-payment-instrument-id>

顧客の支払手段を削除します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Payment Instrument Id (支払手段 ID)

String (文字列)

取得する支払手段の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Delete Customer Product List

<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id-list-id>

顧客商品リストを削除します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Delete Customer Product List Item

<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id-item-id>

顧客商品リストから品目を削除します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

version

String (文字列)

version

x

Item Id (品目 ID)

String (文字列)

更新する商品リスト品目の ID。

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Basket

<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>

バスケットを取得します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Payment Methods For Basket

<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-payment-methods-by-version-organization-id-basket-id>

未決済の支払金額のみを考慮して、既存のバスケットに適用可能な支払方法を取得します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-methods エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Shipping Methods For Shipment

<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-shipments-shipping-methods-by-version-organization-id-basket-id-shipment-id>

バスケットの特定の出荷に適用可能な配送方法を取得します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-methods エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Order

<commerce-cloud-shopper-api:get-checkout-shopper-orders-organizations-orders-by-version-organization-id-order-no>

注文の情報を取得します。この操作では、/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Order No (注文番号)

String (文字列)

変更する注文の注文番号。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Payment Methods For Order

<commerce-cloud-shopper-api:get-checkout-shopper-orders-organizations-orders-payment-methods-by-version-organization-id-order-no>

未決済の支払金額のみを考慮して、既存の注文に適用可能な支払方法を取得します。この操作では、/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-methods エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Order No (注文番号)

String (文字列)

変更する注文の注文番号。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Customer Address

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id-address-name>

住所名で顧客の住所を取得します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Address Name (住所名)

String (文字列)

更新する住所の名前。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Customer Baskets

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-baskets-by-version-organization-id-customer-id>

顧客のバスケットを取得します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/baskets エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Customer

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-by-version-organization-id-customer-id>

顧客、および要求された顧客に関連付けられたすべての既存の住所と支払手段を取得します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Customer Orders

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-orders-by-version-organization-id-customer-id>

すべての顧客の注文のページング可能なリストを返します。デフォルトのページサイズは 10 です。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/orders エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Cross Sites (クロスサイト)

Boolean (ブール)

Cross Sites (クロスサイト)

false

送信元。

String (文字列)

送信元。

期限。

String (文字列)

期限。

status (状況)

String (文字列)

状況。

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

offset

Number (数値)

offset

0

limit (制限)

Number (数値)

要求ごとに取得する最大レコード数 (50 以下)。デフォルトは 10 です。

10

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Customer Payment Instrument

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-payment-instruments-by-version-organization-id-customer-id-payment-instrument-id>

ID で顧客の支払手段を取得します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Payment Instrument Id (支払手段 ID)

String (文字列)

取得する支払手段の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Customer Product Lists

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id>

すべての顧客商品リストを返します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Customer Product List

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id-list-id>

指定された顧客の顧客商品リストとリスト内の品目を返します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Customer Product List Item

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id-item-id>

顧客商品リストの品目、および画像、在庫状況、価格などの実際の商品の詳細を返します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

version

String (文字列)

version

x

Item Id (品目 ID)

String (文字列)

更新する商品リスト品目の ID。

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Public Product Lists By Search Term

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-product-lists-by-version-organization-id>

指定された検索語 (「メールまたは名と姓」など) で定義されているすべての公開商品リストを取得します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/product-lists エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Email (メール)

String (文字列)

商品リストが属する顧客のメールアドレス。

First Name (名)

String (文字列)

商品リストが属する顧客の名。

Last Name (姓)

String (文字列)

商品リストが属する顧客の姓。

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Public Product List

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-product-lists-by-version-organization-id-list-id>

ID 別の公開商品リストととその商品リスト内の品目を取得します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/product-lists/{listId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

List Id (リスト ID)

String (文字列)

リストの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Product List Item

<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-product-lists-items-by-version-organization-id-list-id-item-id>

公開商品リストの品目、および商品、画像、在庫状況、価格などの実際の商品の詳細を取得します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/product-lists/{listId}/items/{itemId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

List Id (リスト ID)

String (文字列)

リストの ID。

x

Item Id (品目 ID)

String (文字列)

品目の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Promotions

<commerce-cloud-shopper-api:get-pricing-shopper-promotions-organizations-promotions-by-version-organization-id>

指定された ID のリストに対して有効なプロモーションの配列を返します。要求 URL では、最大 50 個の ID を指定できます。括弧または区切り文字が含まれる ID を指定した場合、それらの文字を URL エンコードする必要があります。サーバーではプロモーション修飾子またはスケジュールが考慮されないため、各要求では有効なプロモーションのみが返されます。この操作では、/pricing/shopper-promotions/{version}/organizations/{organizationId}/promotions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

ids (ID)

String (文字列)

ids (ID)

x

ロケール。

String (文字列)

ロケール。

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Promotions For Campaign

<commerce-cloud-shopper-api:get-pricing-shopper-promotions-organizations-promotions-campaigns-by-version-organization-id-campaign-id>

検索条件に基づいてプロモーションの取得を処理します。指定された検索条件に一致する有効なプロモーションの配列を返します。要求 URL では、campaign_id パラメーターを指定する必要があります。必要に応じて、start_date パラメーターと end_date パラメーターで日付範囲を指定することもできます。日付範囲を指定するには、両方のパラメーターが必要です。パラメーターを省略すると、サーバーから MissingParameterException エラーが返されます。サーバーではプロモーション修飾子またはスケジュールが考慮されないため、各要求では有効なプロモーションのみが返されます。この操作では、/pricing/shopper-promotions/{version}/organizations/{organizationId}/promotions/campaigns/{campaignId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Campaign Id (キャンペーン ID)

String (文字列)

このキャンペーンに割り当てられているプロモーションを検索します (必須)。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Start Date (開始日)

String (文字列)

ISO8601 日時形式 yyyy-MM-dd''T''HH:mmZ でのプロモーションの開始日

End Date (終了日)

String (文字列)

ISO8601 日時形式 yyyy-MM-dd''T''HH:mmZ でのプロモーションの終了日

currency (通貨)

String (文字列)

価格に指定された通貨ニーモニック。このパラメーターは、商品の提案に対してのみ有効です。

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Categories

<commerce-cloud-shopper-api:get-product-shopper-products-organizations-categories-by-version-organization-id>

URL テンプレートを使用する場合、サーバーは複数のカテゴリ (カテゴリドキュメントの結果オブジェクト) を返します。このテンプレートを使用すると、カテゴリごとに個別の要求を発行することなく 1 つの要求で複数のカテゴリ取得できるため便利です。複数の ID を最大 50 個指定できます。ID のリストは括弧で囲む必要があります。カテゴリ識別子に括弧または区切り記号が含まれている場合、文字を URL エンコードする必要があります。サーバーからはオンラインカテゴリのみが返されます。この操作では、/product/shopper-products/{version}/organizations/{organizationId}/categories エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

ids (ID)

String (文字列)

カテゴリ ID のカンマ区切りのリスト (最大 50)。

x

levels (レベル)

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

j_0
j_1
j_2

サーバーから返されるネストされたサブカテゴリのレベル数を指定します。デフォルト値は 1 です。有効な値は、0、1、2 です。

ロケール。

String (文字列)

ローカルコンテキスト。

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Category

<commerce-cloud-shopper-api:get-product-shopper-products-organizations-categories-by-version-organization-id-id>

以下の URL テンプレートを使用すると、サーバーは ID で識別されるカテゴリを返します。デフォルトでは、サーバーはサブカテゴリの最初のレベルも返しますが、レベルパラメーターを設定することで別のレベルを指定できます。サーバーからはオンラインカテゴリのみが返されます。この操作では、/product/shopper-products/{version}/organizations/{organizationId}/categories/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

id

String (文字列)

要求されたカテゴリの ID。

x

levels (レベル)

Number (数値)

levels (レベル)

ロケール。

String (文字列)

ロケール。

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Products

<commerce-cloud-shopper-api:get-product-shopper-products-organizations-products-by-version-organization-id>

1 回の要求で複数の商品へのアクセスを許可します。オンラインになっていて、サイトカタログに割り当てられている商品のみが返されます。要求できる productIDs の最大数は 24 です。商品の詳細と共に、必要に応じて有効な商品の在庫状況、画像、価格、プロモーション、バリエーションデータが含まれます。この操作では、/product/shopper-products/{version}/organizations/{organizationId}/products エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

ids (ID)

String (文字列)

要求された商品の ID (カンマ区切り、最大 24 個の ID)。

x

Inventory Ids (在庫 ID)。

String (文字列)

在庫状況を表示する必要がある省略可能な在庫リスト ID (カンマ区切り、最大 5 個の inventoryListID)。

currency (通貨)

String (文字列)

価格に指定された通貨ニーモニック。

ロケール。

String (文字列)

ローカルコンテキスト。

All Images (すべての画像)

Boolean (ブール)

要求された商品の画像モデル全体を取得するかどうかを示すフラグ。

false

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Product

<commerce-cloud-shopper-api:get-product-shopper-products-organizations-products-by-version-organization-id-id>

1 つの商品 ID の商品の詳細へのアクセスを許可します。オンラインになっていて、サイトカタログに割り当てられている商品のみが返されます。商品の詳細と共に、必要に応じて商品の availability、images、price、bundled_products、set_products、recommedations、productoptions、variation、promotion が含まれます。この操作では、/product/shopper-products/{version}/organizations/{organizationId}/products/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

id

String (文字列)

要求された商品の ID。

x

Inventory Ids (在庫 ID)。

String (文字列)

在庫状況を表示する必要がある省略可能な在庫リスト ID (カンマ区切り、最大 5 個の inventoryListID)。

currency (通貨)

String (文字列)

価格に指定された通貨ニーモニック。

ロケール。

String (文字列)

ローカルコンテキスト。

All Images (すべての画像)

Boolean (ブール)

要求された商品の画像モデル全体を取得するかどうかを示すフラグ。

false

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Product Search

<commerce-cloud-shopper-api:get-search-shopper-search-organizations-product-search-by-version-organization-id>

商品のキーワードおよび絞り込み検索機能を提供します。商品検索にヒットしたときに商品 ID、リンク、名前のみを返します。検索結果には、オンラインになっていて、サイトカタログに割り当てられている商品のみが含まれます。この操作では、/search/shopper-search/{version}//organizations/{organizationId}/product-search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

q

String (文字列)

検索するクエリ語句。たとえば、商品「shirt」を検索するには、「q=shirt」と入力します。

refine (絞り込み)

Array of String (文字列の配列)

絞り込み属性または値のペアを表すパラメーター。絞り込み属性 ID と値は「=」で区切られます。絞り込み属性のサブセットでは、パイプ (URL エンコードされると「

」) を使用して区切ることで複数の値を指定できます (例: efine=c_refinementColor=red|green|blue)。値の範囲は、refine=price=(100..500) のように指定できます。キーとして refine を使用して複数の絞り込みパラメーターを指定できます (例: refine=price=(0..10)&refine=c_refinementColor=green)。絞り込みは、カスタム定義属性 ID とシステム定義属性 ID のコレクションにすることができますが、検索で一度に受け入れることができる絞り込みは、合計で 9 個のみです。次のシステム絞り込み属性 ID がサポートされています。cgid: 1 つのカテゴリ ID ごとに絞り込むことができます。複数のカテゴリ ID はサポートされていません。 price: 1 つの価格範囲ごとに絞り込むことができます。複数の価格範囲はサポートされていません。 pmid: プロモーション ID ごとに絞り込むことができます。 htypes: 指定されたヒット種別のみを含めて絞り込むことができます。受け入れられる種別は、「product」、「master」、「set」、「bundle」、「slicing_group」 (非推奨)、「variation_group」です。 orderable_only: true が設定されている場合、注文できない商品が検索結果から除外されます。複数の絞り込み値はサポートされていません。

sort (並び替え)

String (文字列)

検索ヒットを並び替えるための並び替えオプションの ID。

currency (通貨)

String (文字列)

価格に指定された通貨ニーモニック。このパラメーターは、返された結果に価格が含まれる場合にのみ有効です。

ロケール。

String (文字列)

ロケール。

offset

Number (数値)

offset

0

limit (制限)

Number (数値)

要求ごとに取得する最大レコード数 (200 以下)。デフォルトは 25 です。

25

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Search Suggestions

<commerce-cloud-shopper-api:get-search-shopper-search-organizations-search-suggestions-by-version-organization-id>

商品、カテゴリ、およびブランドの提案に対するキーワード検索機能を提供します。特定の検索語句に対応する推奨商品、推奨カテゴリ、推奨ブランドを返します。この操作では、/search/shopper-search/{version}//organizations/{organizationId}/search-suggestions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

q

String (文字列)

提案が評価される検索語句 (q)。検索の提案は、3 文字以上 (デフォルト) の検索語句が入力されたときに決まります。この値は、Business Manager で設定できます。

x

limit (制限)

Number (数値)

要求ごとに行われる提案の最大数。値が定義されていない場合、デフォルトで提案種別ごとに 5 個の提案が評価されます。これは、すべての提案種別 (カテゴリ、商品、ブランド、カスタム提案) に影響します。

5

currency (通貨)

String (文字列)

価格に指定された通貨コード。このパラメーターは、商品の提案に対してのみ有効です。

ロケール。

String (文字列)

ロケール。

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Logout Customer

<commerce-cloud-shopper-api:get-shopper-auth-organizations-oauth2-logout-by-version-organization-id>

買い物客をログアウトします。この操作では、/shopper/auth/{version}/organizations/{organizationId}/oauth2/logout エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

バージョン。

x

Organization Id (組織 ID)

String (文字列)

組織 ID。

x

Client id (クライアント ID)

String (文字列)

SLAS クライアント ID。

x

Refresh token (更新トークン)

String (文字列)

アクセストークンの要求中に付与された更新トークン。

x

Channel id (チャネル ID)

String (文字列)

買い物客が ECOM の login エンドポイントを使用して認証する場合、この項目は必須です。

hint (ヒント)

String (文字列)

ユーザーセッションをログアウトするための省略可能な項目。すべてのユーザーセッションをログアウトするには、all-sessions を使用します。この項目が使用されていない場合、現在のユーザーセッションのみがログアウトされます。

Config Ref (設定参照)

ConfigurationProvider

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

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

AUTO (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。
ALWAYS

コネクタは、常に要求コンテンツをストリーミングします。
NEVER

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は [Target Variable (対象変数)] 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Basket

<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>

バスケットを更新します。バスケットの通貨、ソースコード、バスケットのカスタムプロパティ、配送品目のみが考慮されます。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Gift Certificate Item In Basket

<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-gift-certificate-items-by-version-organization-id-basket-id-gift-certificate-item-id>

既存のバスケットのギフト券品目を更新します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Gift Certificate Item Id (ギフト券品目 ID)

String (文字列)

更新するギフト券品目の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Item In Basket

<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-items-by-version-organization-id-basket-id-item-id>

バスケット内の品目を更新します。リクエストボディの次の値がサーバーで考慮されます。- productId: 有効な商品 ID。この値の目的は、バリエーション商品のバリエーションをエクスチェンジすることです。- shipmentId: 有効な出荷 ID。この値の目的は、商品品目を別の出荷に移動することです。- quantity: 0 ～ 999 の数値。この値の目的は、商品品目の数量を変更することです。数量が 0 の場合、商品品目は削除されます。- optionItems/optionValueId: 有効なオプション値 ID。この値の目的は、オプション商品のオプション品目のオプション値をエクスチェンジすることです。これは、商品品目がオプション商品の場合にのみ可能です。オプション値を変更するには、変更する必要のあるオプション品目のコレクションをプロパティ optionItems で指定する必要があります。それらの optionItems には、optionId と optionValueId が含まれている必要があります。この商品品目が表すオプション商品で有効な値を指定する必要があります。指定しない場合、InvalidProductOptionItemException または InvalidProductOptionValueItemException がスローされます。カスタムプロパティ c_<CUSTOM_NAME>: ProductLineItem のカスタム属性 <CUSTOM_NAME> で定義された種別に対応する値。この値の目的は、ProductLineItem で定義されたカスタム属性の値を追加または変更することです。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Item Id (品目 ID)

String (文字列)

更新する品目の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Shipment For Basket

<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-shipments-by-version-organization-id-basket-id-shipment-id>

バスケットの出荷を更新します。出荷は、本文ドキュメントで指定された値で初期化され、後続のデータ API コールで更新できます。本文でプロパティ (ID、配送先住所、配送方法、ギフトのブールフラグ、ギフトメッセージ、カスタムプロパティ) が指定されている場合は考慮します。この操作では、the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Payment Instrument For Order

<commerce-cloud-shopper-api:patch-checkout-shopper-orders-organizations-orders-payment-instruments-by-version-organization-id-order-no-payment-instrument-id>

注文の支払手段を更新します。詳細: 支払手段は、指定された詳細で更新されます。支払方法は注文に該当している必要があります。「GET /baskets/{basketId}/payment-methods」を参照してください。支払方法が「CREDIT_CARD」の場合、要求で paymentCard を指定する必要があります。この操作では、/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Order No (注文番号)

String (文字列)

変更する注文の注文番号。

x

Payment Instrument Id (支払手段 ID)

String (文字列)

更新する支払手段の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Customer Address

<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id-address-name>

住所名で顧客の住所を更新します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Address Name (住所名)

String (文字列)

更新する住所の名前。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Customer

<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-by-version-organization-id-customer-id>

顧客を更新します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

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

Number (数値)

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

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

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

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

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

Streaming Type (ストリーミング種別)

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

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Customer Product List

<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id-list-id>

商品リストを変更します。変更可能なプロパティは、名前、説明、およびリストが公開されるかどうかです。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Customer Product List Item

<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id-item-id>

顧客の商品リストの品目を更新します。リクエストボディで考慮される値は次のとおりです。priority: これは顧客の商品リスト品目の優先度です。public: これは、顧客の商品リスト品目が公開されるのかどうかを示すフラグです。quantity: これは、顧客の商品リスト品目の数量です。商品品目種別でのみ使用します。 c_<CUSTOM_NAME> 形式のカスタムプロパティ: カスタムプロパティは、ProductListItem で定義されたカスタム属性 (<CUSTOM_NAME>) に対応している必要があります。プロパティの値は、ProductListItem で定義されたカスタム属性の型で有効である必要があります。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

version

String (文字列)

version

x

Item Id (品目 ID)

String (文字列)

更新する商品リスト品目の ID。

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Billing Address For Basket

<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-billing-address-by-version-organization-id-basket-id>

バスケットの請求先住所を設定します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/billing-address エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Use As Shipping (配送先として使用)

Boolean (ブール)

Use As Shipping (配送先として使用)

false

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Customer For Basket

<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-customer-by-version-organization-id-basket-id>

既存のバスケットの顧客情報を設定します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/customer エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Shipping Address For Shipment

<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-shipments-shipping-address-by-version-organization-id-basket-id-shipment-id>

バスケットの特定の出荷の配送先住所を設定します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-address エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Use As Billing (請求先として使用)

Boolean (ブール)

Use As Billing (請求先として使用)

false

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Shipping Method For Shipment

<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-shipments-shipping-method-by-version-organization-id-basket-id-shipment-id>

バスケットの特定の出荷に配送方法を設定します。この操作では、/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-method エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Update Customer Password

<commerce-cloud-shopper-api:update-customer-shopper-customers-organizations-customers-password-by-version-organization-id-customer-id>

顧客のパスワードを更新します。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/password エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

顧客 ID。

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

顧客認証設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Authorize Customer

<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-actions-login-by-version-organization-id>

ゲスト顧客または登録顧客の新しい JSON Web トークン (JWT) を取得します。トークンは、HTTP Authorization:Bearer レスポンスヘッダーエントリとして返されます。次のような種類の要求がサポートされています (種別で指定)。Type guest (ゲスト種別) - ゲスト (認証されていない) 顧客を作成し、顧客のトークンを返します。ゲスト用のリクエストボディ : {「種別」: 「ゲスト」} Type credentials (ログイン情報種別) - HTTP Authorization:Basic リクエストヘッダーで渡されたログイン情報を認証し、正常に認証された顧客のトークンを返します。正常に認証されなかった場合は、AuthenticationFailedException をスローします。ゲスト用のリクエストボディ : {「種別」: 「ログイン情報」} Type refresh (更新種別) - HTTP Authorization:Bearer リクエストヘッダーで渡されたトークンを調べ、有効な場合は、有効期限が更新された新しいトークンを返します。ゲスト用のリクエストボディ : {「種別」: 「更新」} ログイン情報種別の要求の場合、顧客のプロファイル属性 (「last-visited」など) を更新します。ログイン試行の最大失敗回数を処理します。JWT に関してトークンには、ヘッダーセクション (使用されるトークン種別とアルゴリズムを指定する)、ペイロードセクション (顧客情報、クライアント ID、問題、有効期限が含まれる)、署名セクション (トークン署名を記録する) の 3 つのセクションがあります。登録顧客がログインしたり (「ログイン情報」種別) やゲスト顧客が要求したり (「ゲスト」種別) すると、トークンが作成されてクライアントに返されます。トークンは、レスポンスヘッダーで Authorization: Bearer --token-- として返されます。クライアントは、フォローアップ要求のリクエストヘッダーに Authorization: Bearer --token-- としてトークンを含める必要があります。サーバーでは、トークンのない、またはトークン署名や有効期限に基づいてトークンを検証できないフォローアップ要求は拒否されます。有効期限が近づいているトークンは、新しいトークンエクスチェンジする (「更新」種別) 必要があります。認証メカニズムとしての JWT の使用についての詳細は、「API Usage > JWT (API 使用状況 > JWT)」を参照してください。この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/login エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

version

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Client Id (クライアント ID)

String (文字列)

アプリケーション識別用のクライアント ID

x

Site Id (サイト ID)

String (文字列)

Site Id (サイト ID)

x

Authorization (認証)

String (文字列)

ログイン情報種別は Authorization:Basic、更新種別は Authorization:Bearer

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が AUTO に設定されている場合、最適な戦略は要求のコンテンツに基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Shopper トークン設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Authenticate Customer

<commerce-cloud-shopper-api:create-shopper-auth-organizations-oauth2-login-by-version-organization-id>

ECOM 顧客を認証します。この操作では、/shopper/auth/{version}/organizations/{organizationId}/oauth2/login エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

バージョン。

x

Organization Id (組織 ID)

String (文字列)

組織 ID。

x

ログイン

String (文字列)

HTTP 基本認証用の Base64 でエンコードされたユーザー名とパスワード。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

[Response Timeout (応答タイムアウト)] 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

AUTO (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。
ALWAYS

コネクタは、常に要求コンテンツをストリーミングします。
NEVER

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は [Target Variable (対象変数)] 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Shopper トークン設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API:UNSUPPORTED_MEDIA_TYPE

Get Access Token

<commerce-cloud-shopper-api:create-shopper-auth-organizations-oauth2-token-by-version-organization-id>

買い物客またはゲストの JWT アクセストークンと更新トークンを取得します。これは、OAuth 2.0 認証コードフローの 2 番目のステップです。クライアントアプリケーションは、クライアントのログイン情報と authorize エンドポイントから取得した認証コードを渡すことで、バックチャネル (信頼済みのサーバー) 経由でアクセストークンを取得します。

非公開クライアント ID を使用してアクセストークンを更新する場合、更新トークンは再生成されません。ただし、公開クライアント ID を使用してアクセストークンを更新する場合、更新トークンは再生成されません。古い更新トークンはすべての更新コールで無効になるため、新しい更新トークンを保存するには更新トークンを置き換える必要があります。

この操作では、/shopper/auth/{version}/organizations/{organizationId}/oauth2/token エンドポイントに対する HTTP POST 要求を行います。

channel_id クエリパラメーターは将来必要になるため、これを使用します。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

version

String (文字列)

バージョン。

x

Organization Id (組織 ID)

String (文字列)

組織 ID。

x

Authorization (認証)

String (文字列)

HTTP 基本認証用の Base64 でエンコードされた文字列。この文字列は、クライアント ID とクライアントシークレットをコロンで区切って構成されます (例: clientId:clientSecret)。許可種別が authorization_code_pkce でない場合、この項目は必須です。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

[Response Timeout (応答タイムアウト)] 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

AUTO (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。
ALWAYS

コネクタは、常に要求コンテンツをストリーミングします。
NEVER

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は [Target Variable (対象変数)] 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

Shopper トークン設定

スロー

COMMERCE-CLOUD-SHOPPER-API:BAD_REQUEST
COMMERCE-CLOUD-SHOPPER-API:CLIENT_ERROR
COMMERCE-CLOUD-SHOPPER-API:CONNECTIVITY
COMMERCE-CLOUD-SHOPPER-API:INTERNAL_SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:NOT_ACCEPTABLE
COMMERCE-CLOUD-SHOPPER-API:NOT_FOUND
COMMERCE-CLOUD-SHOPPER-API:RETRY_EXHAUSTED
COMMERCE-CLOUD-SHOPPER-API:SERVER_ERROR
COMMERCE-CLOUD-SHOPPER-API:SERVICE_UNAVAILABLE
COMMERCE-CLOUD-SHOPPER-API:TIMEOUT
COMMERCE-CLOUD-SHOPPER-API:TOO_MANY_REQUESTS
COMMERCE-CLOUD-SHOPPER-API:UNAUTHORIZED
COMMERCE-CLOUD-SHOPPER-API: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 (キーストア)

Revocation Check (取り消し確認)

Standard Revocation Check (標準の取り消し確認)
Custom Ocsp Responder (カスタム Ocsp レスポンダー)
Crl File (Crl ファイル)

Trust Store (トラストストア)

項目

型

説明

デフォルト値

必須

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 (再接続)
Reconnect Forever (繰り返し再接続)

使用する再接続戦略。

Reconnect (再接続)

項目

型

説明

デフォルト値

必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

再接続を試みる回数。

Reconnect Forever (繰り返し再接続)

項目

型

説明

デフォルト値

必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

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 で表される単位

Commerce Cloud B2C Shop Connector 2.1 リファレンス - Mule 4

制限事項

Am Oauth2 設定

接続種別

Shop Account Manager Oauth2 Connection Provider (Shop Account Manager Oauth2 接続プロバイダー)

パラメーター

関連操作

顧客認証設定

接続種別

Shopper Connection Provider (Shopper 接続プロバイダー)

パラメーター

関連操作

Shopper トークン設定

接続種別

Shopper Token Connection Provider (Shopper トークン接続プロバイダー)

パラメーター

関連操作

操作

Get Reset Password Token

パラメーター

出力

次の設定の場合

スロー

Reset Password

パラメーター

出力

次の設定の場合

スロー

Authorize Trusted System

パラメーター

出力

次の設定の場合

スロー

Get Price Books For Basket

パラメーター

出力

次の設定の場合

スロー

Get Taxes From Basket

パラメーター

出力

次の設定の場合

スロー

Get Taxes From Order

パラメーター

出力

次の設定の場合

スロー

Add Taxes For Basket Item

パラメーター

出力

次の設定の場合

スロー

Add Price Books To Basket

パラメーター

出力

次の設定の場合

スロー

Add Taxes For Basket

パラメーター

出力

次の設定の場合

スロー

Create Basket

パラメーター

出力

次の設定の場合

スロー

Add Coupon To Basket

パラメーター

出力

次の設定の場合

スロー

Add Gift Certificate Item To Basket

パラメーター

出力

次の設定の場合

スロー

Add Item To Basket

パラメーター