B2C Shop Connector 1.0 リファレンス

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

制限事項

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

設定

顧客認証接続プロバイダーと Oauth2 アプリケーション接続プロバイダー認証の設定

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

Name (名前)

String (文字列)

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

x

Connection (接続)

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

x

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

Number (数値)

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

1

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

MINUTES

Name (名前)

String (文字列)

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

x

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

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

Customers Auth Connection Provider (顧客認証接続プロバイダー)

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

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

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

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 (プロキシ設定)

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

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

Boolean (ブール)

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

false

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

Number (数値)

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

-1

Base Uri (ベース URI)

String (文字列)

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

デフォルトのベース URI

Authorization (認証)

String (文字列)

Shopper JWT トークン

x

Type (型)

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

  • CREDENTIALS

  • GUEST

顧客の種別: 登録顧客またはゲスト顧客

x

Protocol (プロトコル)

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

  • HTTP

  • HTTPS

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

HTTP

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

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

OAuth2 Application Connection Provider (Oauth2 アプリケーション接続プロバイダー)

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

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

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

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 (プロキシ設定)

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

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

Boolean (ブール)

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

false

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

Number (数値)

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

-1

ベース URI

String (文字列)

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

デフォルトのベース URI

Protocol (プロトコル)

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

  • HTTP

  • HTTPS

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

HTTP

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

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

Client Id (クライアント ID)

String (文字列)

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

x

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

String (文字列)

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

x

Token Url (トークン URL)

String (文字列)

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

デフォルトのトークン URL

Scopes (スコープ)

String (文字列)

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

x

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

String (文字列)

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

コネクタの Shopper トークンの接続種別

Shopper トークン

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

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

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

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 (プロキシ設定)

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

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

Boolean (ブール)

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

false

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

Number (数値)

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

-1

Base Uri (ベース URI)

String (文字列)

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

デフォルトのベース URI

Type (型)

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

  • CREDENTIALS

  • GUEST

顧客の種別: 登録顧客またはゲスト顧客

x

Protocol (プロトコル)

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

  • HTTP

  • HTTPS

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

HTTP

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

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

操作

Add Coupon To Basket

<commerce-cloud-shopper-api:add-coupon-to-basket>

既存のバスケットにクーポンを追加します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/coupons​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:add-gift-certificate-to-basket>

既存のバスケットにギフト券品目を追加します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:add-item-to-basket>

バスケットに新規品目を追加します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:add-payment-instrument-to-basket>

バスケットに支払手段を追加します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-instruments​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:add-price-books-to-basket>

このメソッドを使用すると、priceBookId の配列を既存のバスケットに配置できます。これは、バスケットの計算に使用されます。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/price-books​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:add-taxes-for-basket>

このメソッドを使用すると、外部の課税データを既存のバスケットに適用して、すべての課税品目の税率と省略可能な値を渡すことができます。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:add-taxes-for-basket-item>

このメソッドを使用すると、外部の課税データを既存のバスケットに適用して、特定の課税品目の税率と省略可能な値を渡すことができます。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId}/taxes​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Item Id (品目 ID)

String (文字列)

更新する品目の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:authorize-customer>

ゲストまたは登録顧客の新しいアクセストークンを取得します。

この操作では、​{baseUri}/customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/login​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Client Id (クライアント ID)

String (文字列)

アプリケーション識別用のクライアント ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Authorization (認証)

String (文字列)

ログイン情報種別は Basic (基本)、更新種別は Bearer (ベアラー)。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

Configurations (設定)

スロー

  • 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:authorize-trusted-system>

サードパーティシステムを使用して、ログイン情報が保存されている登録顧客の JSON Web トークン (JWT) を取得します。loginId と clientId を受け入れ、レスポンスボディで顧客オブジェクトを返し、レスポンスヘッダーで clientId に対して生成された JWT を返します。

この操作では、​/customer/shopper-customers/{version}/organizations/{organizationId}/customers/trusted-system/actions/login​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-basket>

新しいバスケットを作成します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Tax Mode (税金モード)

String (文字列)

Tax Mode (税金モード)

INTERNAL

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-address>

指定された顧客の指定された名前で新しい住所を作成します。

この操作では、​/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-payment-instrument>

顧客情報に支払手段を追加します。

この操作では、​/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-product-list>

顧客商品リストを作成します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-product-list-item>

顧客の商品リストに品目を追加します。リクエストボディで考慮される値は次のとおりです。

type: 有効な型、必須。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-order>

準備されたバスケットに基づいて注文を送信します。リクエストボディで考慮される唯一の値は basketId です。

この操作では、​/checkout/shopper-orders/{version}/organizations/{organizationId}/orders​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-payment-instrument-for-order>

注文に支払手段を追加します。

この操作では、​/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Order Id (注文 ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-shipment-for-basket>

バスケットの新しい出荷を作成します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-basket>

バスケットを削除します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-payment-instrument>

顧客の支払手段を削除します。

この操作では、​/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Payment Instrument Id (支払手段 ID)

String (文字列)

取得する支払手段の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-product-list>`

顧客商品リストを削除します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

List Id (リスト ID)

String (文字列)

リスト ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-product-list-item>

顧客商品リストから品目を削除します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Item Id (品目 ID)

String (文字列)

更新する商品リスト品目の ID。

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

List Id (リスト ID)

String (文字列)

リスト ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-basket>

バスケットを取得します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-categories>

URL テンプレートを使用する場合、サーバーは複数のカテゴリ (カテゴリドキュメントの結果オブジェクト) を返します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Ids

String (文字列)

カテゴリ ID のカンマ区切りのリスト (最大 50)。

x

Levels (レベル)

String (文字列)

サーバーから返されるネストされたサブカテゴリのレベル数を指定します。デフォルト値は 1 です。有効な値は、0、1、2 です。

Locale (ロケール)

String (文字列)

ローカルコンテキスト。

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-category>

以下の URL テンプレートを使用すると、サーバーは ID で識別されるカテゴリを返します。デフォルトでは、サーバーはサブカテゴリの最初のレベルも返しますが、レベルパラメーターを設定することで別のレベルを指定できます。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Id’s

String (文字列)

カテゴリ ID のカンマ区切りのリスト (最大 50)。

x

Levels (レベル)

String (文字列)

サーバーから返されるネストされたサブカテゴリのレベル数を指定します。デフォルト値は 1 です。有効な値は、0、1、2 です。

Locale (ロケール)

String (文字列)

ローカルコンテキスト。

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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>

顧客、および要求された顧客に関連付けられたすべての既存の住所と支払手段を取得します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-address>

住所名で顧客の住所を取得します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Address Name (住所名)

String (文字列)

更新する住所の名前。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-baskets>

顧客のバスケットを取得します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-orders>

すべての顧客の注文のページング可能なリストを返します。デフォルトのページサイズは 10 です。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Cross Sites (クロスサイト)

Boolean (ブール)

Cross Sites (クロスサイト)

Until (期限)

String (文字列)

期限。

Status (状況)

String (文字列)

状況。

From (送信元)

String (文字列)

送信元。

オフセット

Integer (整数)

offset

0

Limit (制限)

Integer (整数)

要求ごとに取得する最大レコード数 (50 以下)。

10

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-payment-instrument>

ID で顧客の支払手段を取得します。

この操作では、​/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Payment Instrument Id (支払手段 ID)

String (文字列)

取得する支払手段の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-product-list>

指定された顧客の顧客商品リストとリスト内の品目を返します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-product-list-item>

顧客商品リストの品目、および画像、在庫状況、価格などの実際の商品の詳細を返します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Item Id (品目 ID)

String (文字列)

更新する商品リスト品目の ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-product-lists>

すべての顧客商品リストを返します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:get-gift-certificate>

既存のギフト券を取得するアクション。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-order>

注文の情報を取得します。

この操作では、​/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Order Id (注文 ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-payment-methods-for-basket>

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-methods​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-payment-methods-for-order>

未決済の支払金額のみを考慮して、既存の注文に適用可能な支払方法を取得します。

この操作では、​/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-methods​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Order Id (注文 ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-price-books-for-basket>

既存のバスケットに適用可能な価格表を取得します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/price-books​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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>

1 つの商品 ID の商品の詳細へのアクセスを許可します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Id

String (文字列)

要求された商品の ID。

x

Inventory Ids (在庫 ID)。

String (文字列)

在庫状況を表示する必要がある省略可能な在庫リスト ID (カンマ区切り、最大 5 個の inventoryListID)。

通貨

String (文字列)

価格に指定された通貨ニーモニック。

Locale (ロケール)

String (文字列)

ローカルコンテキスト。

All Images (すべての画像)

Boolean (ブール)

要求された商品の画像モデル全体を取得するかどうかを示すフラグ。

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-product-list-item>

公開商品リストの品目、および商品、画像、在庫状況、価格などの実際の商品の詳細を取得します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

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 (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-products>

1 回の要求で複数の商品へのアクセスを許可します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Id’s

String (文字列)

要求された商品の ID (カンマ区切り、最大 24 個の ID)。

x

Inventory Ids (在庫 ID)。

String (文字列)

在庫状況を表示する必要がある省略可能な在庫リスト ID (カンマ区切り、最大 5 個の inventoryListID)。

通貨

String (文字列)

価格に指定された通貨ニーモニック。

Locale (ロケール)

String (文字列)

ローカルコンテキスト。

All Image (すべての画像)

Boolean (ブール)

要求された商品の画像モデル全体を取得するかどうかを示すフラグ。

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-promotions>

指定された ID のリストに対して有効なプロモーションの配列を返します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Id’s

String (文字列)

要求されたプロモーションの ID。

x

Locale (ロケール)

String (文字列)

ロケール。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-promotions-for-campaign>

検索条件に基づいてプロモーションの取得を処理します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Campaign Id (キャンペーン ID)

String (文字列)

このキャンペーンに割り当てられているプロモーションを検索します (必須)。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Start Date (開始日)

String (文字列)

ISO8601 日時形式 yyyy-MM-dd''T''HH:mmZ でのプロモーションの開始日。

End Date (終了日)

String (文字列)

ISO8601 日時形式 yyyy-MM-dd''T''HH:mmZ でのプロモーションの終了日。

通貨

String (文字列)

価格に指定された通貨ニーモニック。このパラメーターは、商品の提案に対してのみ有効です。

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-public-product-list>

ID 別の公開商品リストととその商品リスト内の品目を取得します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

List Id (リスト ID)

String (文字列)

リストの ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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 By Search Term

<commerce-cloud-shopper-api:get-public-product-list-by-search-term>

指定された検索語 (「メールまたは名と姓」など) で定義されているすべての公開商品リストを取得します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Email (メール)

String (文字列)

商品リストが属する顧客のメールアドレス。

First Name (名)

String (文字列)

商品リストが属する顧客の名。

Last Name (姓)

String (文字列)

商品リストが属する顧客の姓。

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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 Reset Password Token

<commerce-cloud-shopper-api:get-reset-password-token>

パスワードのリセットトークンを取得します。

この操作では、​/customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/create-reset-token​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-suggestions>

商品、カテゴリ、およびブランドの提案に対するキーワード検索機能を提供します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Q

String (文字列)

提案が評価される検索語句 (q)。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Limit (制限)

Integer (整数)

要求ごとに行われる提案の最大数。

5

通貨

String (文字列)

価格に指定された通貨コード。このパラメーターは、商品の提案に対してのみ有効です。

Locale (ロケール)

String (文字列)

ロケール。

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-shipping-methods-for-shipment>

バスケットの特定の出荷に適用可能な配送方法を取得します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-methods​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-taxes-from-basket>

このメソッドは、PUT taxes API によって設定された外部課税データを提供します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/taxes​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-taxes-from-order>

このメソッドは、注文の作成中にバスケットから転送された注文の外部課税データを提供します。

この操作では、​/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/taxes​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Order No (注文番号)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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​

Invalid Customer Auth

<commerce-cloud-shopper-api:invalid-customer-auth>

ヘッダーで提供される JSON Web トークン (JWT) を無効にします。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:product-search>

商品のキーワードおよび絞り込み検索機能を提供します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Q

String (文字列)

検索するクエリ語句。たとえば、商品「shirt」を検索するには、「q=shirt」と入力します。

Refines (絞り込み)

List

絞り込み属性または値のペアを表すパラメーター。絞り込み属性 ID と値は「=」で区切られます。

Sort (並び替え)

String (文字列)

検索ヒットを並び替えるための並び替えオプションの ID。

通貨

String (文字列)

価格に指定された通貨ニーモニック。このパラメーターは、返された結果に価格が含まれる場合にのみ有効です。

Locale (ロケール)

String (文字列)

ロケール。

オフセット

Integer (整数)

offset

0

Limit (制限)

Integer (整数)

要求ごとに取得する最大レコード数 (200 以下)。

25

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:register-customer>

新規顧客を登録します。必須データは、ログイン情報、プロファイルの姓、メールです。 これには、種別「guest」で POST /customers/auth API を使用して取得する必要がある JSON Web トークン (JWT) が必要です。

この操作では、/customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/create-reset-token エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:remove-coupon-from-basket>

バスケットからクーポンを削除します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/coupons/{couponItemId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

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

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:remove-customer-address>

住所名で顧客の住所を削除します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Address Name (住所名)

String (文字列)

更新する住所の名前。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:remove-gift-certificate-item-from-basket>

既存のバスケットからギフト券品目を削除します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

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

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:remove-item-from-basket>

バスケットから商品品目を削除します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Item Id (品目 ID)

String (文字列)

更新する品目の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:remove-payment-instrument-from-basket>

バスケットの支払手段を削除します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-instruments/{paymentInstrumentId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Payment Instrument Id (支払手段 ID)

String (文字列)

支払手段 ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:remove-payment-instrument-from-order>

注文の支払手段を削除します。

この操作では、​/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Order No (注文番号)

String (文字列)

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

x

Payment Instrument Id (支払手段 ID)

String (文字列)

更新する支払手段の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:remove-shipment-from-basket>

指定された出荷、関連するすべての商品、ギフト券、配送、価格調整品目をバスケットから削除します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:reset-password>

顧客のパスワードをリセットします。

この操作では、​/customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/reset​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:update-basket>

バスケットを更新します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}​ エンドポイントに HTTP PATCH 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-billing-address-for-basket>

バスケットの請求先住所を設定します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/billing-address​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Use As Shipping (配送先として使用)

Boolean (ブール)

配送先として使用します。

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:update-customer>

顧客を更新します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:update-customer-address>

住所名で顧客の住所を更新します。

この操作では、​/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName}​ エンドポイントに HTTP PATCH 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Address Name (住所名)

String (文字列)

更新する住所の名前。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-customer-password>

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

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

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-password>

顧客のパスワードを更新します。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:update-customer-product-list>

商品リストを変更します。変更可能なプロパティは、名前、説明、およびリストが公開されるかどうかです。

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

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:update-customer-product-list-item>

顧客の商品リストの品目を更新します。

この操作では、​/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId}​ エンドポイントに HTTP PATCH 要求を行います。

パラメーター

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

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

Organization Id (組織 ID)

x

Customer Id (顧客 ID)

String (文字列)

Customer Id (顧客 ID)

x

List Id (リスト ID)

String (文字列)

商品リスト ID。

x

Item Id (品目 ID)

String (文字列)

更新する商品リスト品目の ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:update-gift-certificate-item-in-basket>

既存のバスケットのギフト券品目を更新します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId}​ エンドポイントに HTTP PATCH 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Gift Certificate Item Id (ギフト券品目 ID)

String (文字列)

更新するギフト券品目の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:update-item-in-basket>

バスケット内の品目を更新します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId}​ エンドポイントに HTTP PATCH 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Item Id (品目 ID)

String (文字列)

更新する品目の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:update-payment-instrument-for-order>

注文の支払手段を更新します。詳細: 支払手段は、指定された詳細で更新されます。

この操作では、​/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}​ エンドポイントに HTTP PATCH 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Order No (注文番号)

String (文字列)

変更する注文の注文番号。

x

Payment Instrument Id (支払手段 ID)

String (文字列)

更新する支払手段の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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:update-shipment-for-basket>

バスケットの出荷を更新します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}​ エンドポイントに HTTP PATCH 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-shipping-address-for-shipment>

バスケットの特定の出荷の配送先住所を設定します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-address​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Use As Billing (請求先として使用)

Boolean (ブール)

請求先として使用します。

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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-shipping-method-for-shipment>

バスケットの特定の出荷に配送方法を設定します。

この操作では、​/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-method​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

バージョン

String (文字列)

バージョン

x

Organization Id (組織 ID)

String (文字列)

要求を行っている組織の識別子。

x

Basket Id (バスケット ID)

String (文字列)

変更するバスケットの ID。

x

Shipment Id (出荷 ID)

String (文字列)

変更する出荷の ID。

x

Site Id (サイト ID)

String (文字列)

サイト ID。

x

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト) の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

スロー

  • 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 (取り消し確認)

トラストストア

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用するキーの別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

項目 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

ReconnectForever

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位。

Http Response Attributes (HTTP 応答属性)

項目 説明 デフォルト値 必須

Status Code (状況コード)

Number (数値)

x

Headers (ヘッダー)

Object (オブジェクト)

x

Reason Phrase (理由を示す語句)

String (文字列)

x

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量です。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従って拡張され、上限は maxInMemorySize となります。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

これらのすべての属性の単位

Repeatable File Store Stream (反復可能なファイルストアストリーム)

項目 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で、メモリ内に保持することが許可されるインスタンスの初期容量です。このバッファに収めることができる量よりも多くのデータがストリームに含まれる場合、バッファは、bufferSizeIncrement 属性に従って maxInMemorySize の上限まで拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

これは、初期サイズを超えた場合に、バッファサイズがどれだけ拡張されるかです。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目 説明 デフォルト値 必須

In Memory Objects (メモリ内オブジェクト)

Number (数値)

メモリ内に保持されるインスタンスの最大量。これ以上の量が必要な場合、コンテンツはディスク上にバッファされます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位