B2C Shop Connector 1.0 Reference - Mule 4
Anypoint Connector for Salesforce Commerce Cloud B2C Shop APIs (B2C Shop Connector) is an operation-based connector, which means that when you add the connector to your flow, you need to configure a specific operation the connector is intended to perform.
Limitations
-
Salesforce Commerce Cloud B2C Data Connector and Salesforce Commerce Cloud B2C Shop Connector cannot be run in the same application.
Configurations
Customer Auth Connection Provider and OAuth2 Application Connection Provider Configurations
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
||
Response Timeout |
Number |
The timeout for request to the remote service. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
MINUTES |
|
Name |
String |
The identifier of this element used to reference it in other components |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit. |
Customers Auth Connection Provider
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Connection Timeout |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection will be closed after the first request is completed. |
true |
|
Max Connections |
Number |
The maximum number of outbound connections that will be kept open at the same time |
-1 |
|
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the connection Idle Timeout |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||
Stream Response |
Boolean |
Whether or not received responses should be streamed |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base Uri |
String |
Parameter base URI, each instance/tenant gets its own |
default base URI |
|
Authorization |
String |
Shopper JWT Token |
x |
|
Type |
Enumeration, one of:
|
Customer type: registered customer or guest customer |
x |
|
Protocol |
Enumeration, one of:
|
Protocol to use for communication. Valid values are HTTP and HTTPS |
HTTP |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
OAuth2 Application Connection Provider
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Connection Timeout |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection will be closed after the first request is completed. |
true |
|
Max Connections |
Number |
The maximum number of outbound connections that will be kept open at the same time |
-1 |
|
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the connection Idle Timeout |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||
Stream Response |
Boolean |
Whether or not received responses should be streamed |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base URI |
String |
Parameter base URI, each instance/tenant gets its own |
default base URI |
|
Protocol |
Enumeration, one of:
|
Protocol to use for communication. Valid values are HTTP and HTTPS |
HTTP |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, the deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
|||
Client Id |
String |
The OAuth client id as registered with the service provider, need to contact Salesforce for this detail. |
x |
|
Client Secret |
String |
The OAuth client secret as registered with the service provider, need to contact Salesforce for this detail. |
x |
|
Token Url |
String |
The service provider’s token endpoint URL |
default token URL |
|
Scopes |
String |
The OAuth scopes to be requested during the dance. |
x |
|
Object Store |
String |
A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one. |
Connection Type for Connector Shopper Token
Shopper Token
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Connection Timeout |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection will be closed after the first request is completed. |
true |
|
Max Connections |
Number |
The maximum number of outbound connections that will be kept open at the same time |
-1 |
|
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the connection Idle Timeout |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||
Stream Response |
Boolean |
Whether or not received responses should be streamed |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base Uri |
String |
Parameter base URI, each instance/tenant gets its own |
default base URI |
|
Type |
Enumeration, one of:
|
Customer type: registered customer or guest customer |
x |
|
Protocol |
Enumeration, one of:
|
Protocol to use for communication. Valid values are HTTP and HTTPS |
HTTP |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
Add Coupon To Basket
<commerce-cloud-shopper-api:add-coupon-to-basket>
Adds a coupon to an existing basket.
This operation makes an HTTP POST request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/coupons endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization that is making the request. |
x |
|
Basket Id |
String |
The ID of the basket to modify. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component. |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Adds a gift certificate item to an existing basket.
This operation makes an HTTP POST request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Adds new items to a basket.
This operation makes an HTTP POST request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Adds a payment instrument to a basket.
This operation makes an HTTP POST request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-instruments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation.
This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/price-books endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
This method allows you to apply external taxation data to an existing basket to be able to pass tax rates and optional values for all taxable line items.
This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/taxes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
This method allows you to apply external taxation data to an existing basket to be able to pass tax rates and optional values for a specific taxable line item.
This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId}/taxes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Item Id |
String |
The ID of the item to be updated. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Obtains a new access token for a guest or registered customer.
This operation makes an HTTP POST request to the {baseUri}/customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/login endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Client Id |
String |
Client Id for application identification |
x |
|
Site Id |
String |
Site id |
x |
|
Authorization |
String |
Basic for type credentials and Bearer for type refresh |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Obtain the JSON Web Token (JWT) for registered customers whose credentials are stored using a third party system. Accepts loginId and clientId, returns a customer object in the response body and the JWT generated against the clientId in the response header.
This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/trusted-system/actions/login endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Creates a new basket.
This operation makes an HTTP POST request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Tax Mode |
String |
Tax Mode |
INTERNAL |
x |
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Creates a new address with the given name for the given customer.
This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Adds a payment instrument to the customer information.
This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Creates a customer product list.
This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Adds an item to the customer’s product list. Considered values from the request body are:
type: A valid type, mandatory.
This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
List Id |
String |
Product List Id |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Submits an order based on a prepared basket. The only considered value from the request body is basketId.
This operation makes an HTTP POST request to the /checkout/shopper-orders/{version}/organizations/{organizationId}/orders endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Adds a payment instrument to an order.
This operation makes an HTTP POST request to the /checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Order Id |
String |
The order number of the order to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Creates a new shipment for a basket.
This operation makes an HTTP POST request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Removes a basket.
This operation makes an HTTP DELETE request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Deletes a customer’s payment instrument.
This operation makes an HTTP DELETE request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Payment Instrument Id |
String |
The ID of the payment instrument to be retrievedCustomer. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>`
Deletes a customer product list.
This operation makes an HTTP DELETE request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
List Id |
String |
List id |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Removes an item from a customer product list.
This operation makes an HTTP DELETE request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Item Id |
String |
The ID of the product list item to update. |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
List Id |
String |
List id |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Gets a basket.
This operation makes an HTTP GET request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
When you use the URL template, the server returns multiple categories (a result object of category documents).
This operation makes an HTTP GET request to the /product/shopper-products/{version}/organizations/{organizationId}/categories endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Ids |
String |
The comma separated list of category IDs (max 50). |
x |
|
Levels |
String |
Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. |
||
Locale |
String |
The locale context. |
||
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
When you use the URL template below, the server returns a category identified by its ID; by default, the server also returns the first level of subcategories, but you can specify another level by setting the levels parameter.
This operation makes an HTTP GET request to the /product/shopper-products/{version}/organizations/{organizationId}/categories/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Id’s |
String |
The comma separated list of category IDs (max 50). |
x |
|
Levels |
String |
Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. |
||
Locale |
String |
The locale context. |
||
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Gets a customer with all existing addresses and payment instruments associated with the requested customer.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Retrieves a customer’s address by address name.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Address Name |
String |
The name of the address to update. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Gets the baskets of a customer.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/baskets endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Returns a pageable list of all customer’s orders. The default page size is 10.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/orders endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Site Id |
String |
Site id |
x |
|
Cross Sites |
Boolean |
Cross Sites |
||
Until |
String |
until |
||
Status |
String |
status |
||
From |
String |
from |
||
Offset |
Integer |
offset |
0 |
|
Limit |
Integer |
Maximum records to retrieve per request, not to exceed 50. |
10 |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Retrieves a customer’s payment instrument by its ID.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Payment Instrument Id |
String |
The ID of the payment instrument to be retrievedCustomer. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Returns a customer product list of the given customer and the items in the list.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
List Id |
String |
The product list ID. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Returns an item of a customer product list and the actual product details like image, availability and price.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Site Id |
String |
Site id |
x |
|
List Id |
String |
The product list ID. |
x |
|
Item Id |
String |
The ID of the product list item to update. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Returns all customer product lists.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Action to retrieve an existing gift certificate.
This operation makes an HTTP POST request to the /pricing/shopper-gift-certificates/{version}/organizations/{organizationId}/gift-certificate endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Gets information for an order.
This operation makes an HTTP GET request to the /checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Order Id |
String |
The order number of the order to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
This operation makes an HTTP GET request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-methods endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Gets the applicable payment methods for an existing order considering the open payment amount only.
This operation makes an HTTP GET request to the /checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-methods endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Order Id |
String |
The order number of the order to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Gets applicable price books for an existing basket.
This operation makes an HTTP GET request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/price-books endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Allows access to product details for a single product ID.
This operation makes an HTTP GET request to the /product/shopper-products/{version}/organizations/{organizationId}/products/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Id |
String |
The ID of the requested product. |
x |
|
Inventory Ids |
String |
The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs). |
||
Currency |
String |
The currency mnemonic specified for price. |
||
Locale |
String |
The locale context. |
||
All Images |
Boolean |
The flag that indicates whether to retrieve the whole image model for the requested product. |
||
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Retrieves an item from a public product list and the actual product details like product, image, availability and price.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/product-lists/{listId}/items/{itemId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
List Id |
String |
The ID of the list. |
x |
|
Item id |
String |
The ID of the item. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Allows access to multiple products by a single request.
This operation makes an HTTP GET request to the /product/shopper-products/{version}/organizations/{organizationId}/products endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Id’s |
String |
The IDs of the requested products (comma-separated, max 24 IDs). |
x |
|
Inventory Ids |
String |
The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs). |
||
Currency |
String |
The currency mnemonic specified for price. |
||
Locale |
String |
The locale context. |
||
All Image |
Boolean |
The flag that indicates whether to retrieve the whole image model for the requested product. |
||
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Returns an array of enabled promotions for a list of specified IDs.
This operation makes an HTTP GET request to the /pricing/shopper-promotions/{version}/organizations/{organizationId}/promotions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Site Id |
String |
Site id |
x |
|
Id’s |
String |
The id of the requested promotion. |
x |
|
Locale |
String |
locale |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Handles get promotion by filter criteria.
This operation makes an HTTP GET request to the /pricing/shopper-promotions/{version}/organizations/{organizationId}/promotions/campaigns/{campaignId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Campaign Id |
String |
Find the promotions assigned to this campaign (mandatory). |
x |
|
Site Id |
String |
Site id |
x |
|
Start Date |
String |
The start date of the promotion in ISO8601 date time format: yyyy-MM-dd''T''HH:mmZ. |
||
End Date |
String |
The end date of the promotion in ISO8601 date time format: yyyy-MM-dd''T''HH:mmZ. |
||
Currency |
String |
The currency mnemonic specified for price. This parameter is effective only for product suggestions. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Retrieves a public product list by ID and the items under that product list.
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/product-lists/{listId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
List Id |
String |
The ID of the list. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Retrieves all public product lists as defined by the given search term (for example, email OR first name and last name).
This operation makes an HTTP GET request to the /customer/shopper-customers/{version}/organizations/{organizationId}/product-lists endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
String |
The email address of the customer the product lists belong to. |
|||
First Name |
String |
The first name of the customer the product lists belong to. |
||
Last Name |
String |
The last name of the customer the product lists belong to. |
||
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Get reset password token.
This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/create-reset-token endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Provides keyword search functionality for products, categories, and brands suggestions.
This operation makes an HTTP GET request to the /search/shopper-search/{version}/organizations/{organizationId}/search-suggestions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Q |
String |
The search phrase (q) for which suggestions are evaluated. |
x |
|
Site Id |
String |
Site id |
x |
|
Limit |
Integer |
The maximum number of suggestions made per request. |
5 |
|
Currency |
String |
The currency code specified for price. This parameter is effective only for product suggestions. |
||
Locale |
String |
locale |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Gets the applicable shipping methods for a certain shipment of a basket.
This operation makes an HTTP GET request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-methods endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Shipment Id |
String |
The ID of the shipment to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
This method gives you the external taxation data set by the PUT taxes API.
This operation makes an HTTP GET request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/taxes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
This method gives you the external taxation data of the order transferred from the basket during order creation.
This operation makes an HTTP GET request to the /checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/taxes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Order No |
String |
The order number of the order to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Invalidates the JSON Web Token (JWT) provided in the header.
This operation makes an HTTP DELETE request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/logout endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Provides keyword and refinement search functionality for products.
This operation makes an HTTP GET request to the /search/shopper-search/{version}/organizations/{organizationId}/product-search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Site Id |
String |
Site id |
x |
|
Q |
String |
The query phrase to search for. For example to search for a product "shirt", type q=shirt. |
||
Refines |
List |
Parameter that represents a refinement attribute or values pair. Refinement attribute ID and values are separated by '='. |
||
Sort |
String |
The ID of the sorting option to sort the search hits. |
||
Currency |
String |
The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices. |
||
Locale |
String |
locale |
||
Offset |
Integer |
offset |
0 |
|
Limit |
Integer |
Maximum records to retrieve per request, not to exceed 200. |
25 |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type "guest".
This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/create-reset-token endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Removes a coupon from the basket.
This operation makes an HTTP DELETE request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/coupons/{couponItemId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id a |
String |
The ID of the basket to be modified. |
x |
|
Coupon Item Id |
String |
The ID of the coupon item to be removed. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Deletes a customer’s address by address name.
This operation makes an HTTP DELETE request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Address Name |
String |
The name of the address to update. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Deletes a gift certificate item from an existing basket.
This operation makes an HTTP DELETE request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Gift Certificate Item Id |
String |
The ID of the gift certificate item to be updated. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Removes a product item from the basket.
This operation makes an HTTP DELETE request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Item Id |
String |
The ID of the item to be updated. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Removes a payment instrument of a basket.
This operation makes an HTTP DELETE request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-instruments/{paymentInstrumentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Payment Instrument Id |
String |
Payment Instrument Id. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Removes a payment instrument of an order.
This operation makes an HTTP DELETE request to the /checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Order No |
String |
The order number of the order to be modified. |
x |
|
Payment Instrument Id |
String |
The ID of the payment instrument to be updated. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Removes a specified shipment and all associated product, gift certificate, shipping, and price adjustment line items from a basket.
This operation makes an HTTP DELETE request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Shipment Id |
String |
The ID of the shipment to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Reset customer password.
This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/reset endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Updates a basket.
This operation makes an HTTP PATCH request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Sets the billing address of a basket.
This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/billing-address endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Use As Shipping |
Boolean |
Use As Shipping. |
||
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Updates a customer.
This operation makes an HTTP PATCH request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Updates a customer’s address by address name.
This operation makes an HTTP PATCH request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Address Name |
String |
The name of the address to update. |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/customer endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Updates the customer’s password.
This operation makes an HTTP PUT request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/password endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Changes a product list. Changeable properties are the name, description, and if the list is public.
This operation makes an HTTP PATCH request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
List Id |
String |
Product List Id |
x |
|
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Updates an item of a customer’s product list.
This operation makes an HTTP PATCH request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
Organization Id |
x |
|
Customer Id |
String |
Customer Id |
x |
|
List Id |
String |
Product List Id |
x |
|
Item Id |
String |
The ID of the product list item to update. |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Site Id |
String |
Site id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Updates a gift certificate item of an existing basket.
This operation makes an HTTP PATCH request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Gift Certificate Item Id |
String |
The ID of the gift certificate item to be updated. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Updates an item in a basket.
This operation makes an HTTP PATCH request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Item Id |
String |
The ID of the item to be updated. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Updates a payment instrument of an order. Details: The payment instrument is updated with the provided details.
This operation makes an HTTP PATCH request to the /checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Order No |
String |
The order number of the order to be modified. |
x |
|
Payment Instrument Id |
String |
The ID of the payment instrument to be updated. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Updates a shipment for a basket.
This operation makes an HTTP PATCH request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Shipment Id |
String |
The ID of the shipment to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Sets a shipping address of a specific shipment of a basket.
This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-address endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Shipment Id |
String |
The ID of the shipment to be modified. |
x |
|
Use As Billing |
Boolean |
Use As Billing. |
||
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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>
Sets a shipping method to a specific shipment of a basket.
This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-method endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Version |
String |
Version |
x |
|
Organization Id |
String |
An identifier for the organization the request is being made by. |
x |
|
Basket Id |
String |
The ID of the basket to be modified. |
x |
|
Shipment Id |
String |
The ID of the shipment to be modified. |
x |
|
Site Id |
String |
Site id |
x |
|
Content |
Binary |
The content to use |
#[payload] |
x |
Config Ref |
ConfigurationProvider |
The name of the configuration to be used to execute this component |
x |
|
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Target Variable |
String |
Name of the variable in which to store the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
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
Types
Proxy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Host |
String |
x |
||
Port |
Number |
x |
||
Username |
String |
|||
Password |
String |
|||
Non Proxy Hosts |
String |
Tls
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols |
String |
A comma separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom OCSP Responder
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Reconnection
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
||
Reconnection Strategy |
The reconnection strategy to use |
Reconnect
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
Count |
Number |
How many reconnection attempts to make. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
true |
ReconnectForever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
true |
Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
Http Response Attributes
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. |
||
Max Buffer Size |
Number |
This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |
Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects |
Number |
This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |