Commerce Cloud B2C Shop Connector 2.1 Reference | MuleSoft Documentation
# Commerce Cloud B2C Shop Connector 2.1 Reference
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.  
---  
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.


## Am Oauth2 Config
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection |  Shop Account Manager Oauth2 Connection Provider | The connection types that can be provided to this configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
The identifier of this element used to reference it in other components  
Expiration Policy |  Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.  
### Connection Types
#### Shop Account Manager Oauth2 Connection Provider
##### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | Timeout for establishing connections to the remote service  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the Connection Timeout  
Use Persistent Connections | If false, each connection will be closed after the first request is completed.  
Max Connections | The maximum number of outbound connections that will be kept open at the same time  
Connection Idle Timeout | Timeout for how long a connection can remain idle before it is closed  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the connection Idle Timeout  
Proxy Config | Reusable configuration element for outbound connections through a proxy  
Stream Response | Whether or not to stream received responses.  
Response Buffer Size | The space in bytes for the buffer where the HTTP response will be stored.  
Base Uri | Each instance, or tenant, gets its own base URI. | `https://{shortCode}.api.commercecloud.salesforce.com`  
TLS Configuration  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
#### Associated Operations
  * Add Price Books To Basket
  *   *   *   * Get Price Books For Basket
  *   *   *   * 

## Customer Auth Config
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection |  Shopper Connection Provider | The connection types that can be provided to this configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
The identifier of this element used to reference it in other components  
Expiration Policy |  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.  
### Connection Types
#### Shopper Connection Provider
##### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | The timeout for establishing connections to the remote service  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the Connection Timeout  
Use Persistent Connections | If false, each connection will be closed after the first request is completed.  
Max Connections | The maximum number of outbound connections that will be kept open at the same time  
Connection Idle Timeout | A timeout for how long a connection can remain idle before it is closed  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the connection Idle Timeout  
Proxy Config | Reusable configuration element for outbound connections through a proxy  
Stream Response | Whether or not received responses should be streamed  
Response Buffer Size | The space in bytes for the buffer where the HTTP response is stored.  
Base Uri | Each instance, or tenant, gets its own base URI. | `https://{shortCode}.api.commercecloud.salesforce.com`  
Authorization | Shopper JWT token  
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  
#### Associated Operations
  *   * Add Gift Certificate Item To Basket
  *   * Add Payment Instrument To Basket
  *   *   * Create Customer Payment Instrument
  * Create Customer Product List
  * Create Customer Product List Item
  *   * Create Payment Instrument For Order
  * Create Shipment For Basket
  *   * Delete Customer Payment Instrument
  * Delete Customer Product List
  * Delete Customer Product List Item
  *   *   *   *   *   * Get Customer Payment Instrument
  *   * Get Customer Product List Item
  * Get Customer Product Lists
  *   * Get Payment Methods For Basket
  * Get Payment Methods For Order
  *   *   *   * Get Promotions For Campaign
  *   * Get Public Product Lists By Search Term
  *   * Get Shipping Methods For Shipment
  *   *   *   *   *   *   * Remove Gift Certificate Item From Basket
  *   * Remove Payment Instrument From Basket
  * Remove Payment Instrument From Order
  * Remove Shipment From Basket
  *   * Update Billing Address For Basket
  *   *   * Update Customer For Basket
  *   * Update Customer Product List
  * Update Customer Product List Item
  * Update Gift Certificate Item In Basket
  *   * Update Payment Instrument For Order
  * Update Shipment For Basket
  * Update Shipping Address For Shipment
  * Update Shipping Method For Shipment


## Shopper Token Config
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection |  Shopper Token Connection Provider | The connection types that can be provided to this configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
## Shopper Token Config
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection |  Shopper Token Connection Provider | The connection types that can be provided to this configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
The identifier of this element used to reference it in other components  
Expiration Policy |  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.  
### Connection Types
#### Shopper Token Connection Provider
##### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | The timeout for establishing connections to the remote service  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the Connection Timeout  
Use Persistent Connections | If false, each connection will be closed after the first request is completed.  
Max Connections | The maximum number of outbound connections that will be kept open at the same time  
Connection Idle Timeout | A timeout for how long a connection can remain idle before it is closed  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit which qualifies the connection Idle Timeout  
Proxy Config | Reusable configuration element for outbound connections through a proxy  
Stream Response | Whether or not received responses should be streamed  
Response Buffer Size | The space in bytes for the buffer where the HTTP response will be stored.  
Base Uri | Each instance, or tenant, gets its own base URI. | `https://{shortCode}.api.commercecloud.salesforce.com`  
TLS Configuration  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
#### Associated Operations
  *   *   * 

## Get Reset Password Token
`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-password-actions-create-reset-token-by-version-organization-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable in which to store the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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:create-customer-shopper-customers-organizations-customers-password-actions-reset-by-version-organization-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | Timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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:create-customer-shopper-customers-organizations-customers-trusted-system-actions-login-by-version-organization-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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-checkout-shopper-baskets-organizations-baskets-price-books-by-version-organization-id-basket-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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-checkout-shopper-baskets-organizations-baskets-taxes-by-version-organization-id-basket-id>`
This method gives you the external taxation data set by the PUT taxes API. This endpoint. can be called only if external taxation mode was used for basket creation. See POST /baskets for more information. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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-checkout-shopper-orders-organizations-orders-taxes-by-version-organization-id-order-no>`
This method gives you the external taxation data of the order transferred from the basket during order creation. This endpoint. can be called only if external taxation was used. See POST /baskets for more information. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Order No | The order number of the order to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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:update-checkout-shopper-baskets-organizations-baskets-items-taxes-by-version-organization-id-basket-id-item-id>`
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 endpoint. can be called only if external taxation mode was used for basket creation. See POST /baskets for more information. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
The ID of the item to be updated.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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:update-checkout-shopper-baskets-organizations-baskets-price-books-by-version-organization-id-basket-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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:update-checkout-shopper-baskets-organizations-baskets-taxes-by-version-organization-id-basket-id>`
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 endpoint. can be called only if external taxation mode was used for basket creation. See POST /baskets for more information. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Am Oauth2 Config


### 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-checkout-shopper-baskets-organizations-baskets-by-version-organization-id>`
Creates a new basket. The created basket is initialized with default values. Data provided in the body document is populated into the created basket. It can be updated with API endpoint.s listed below. The taxMode query parameter can be used to choose the basket tax mode. The default is internal, in which case the tax calculation is done automatically based on internal tax tables. Alternatively, external taxation mode can be set which allows manual modification of the tax rates and values. External tax data is mandatory for product line items, option line items, shipping line items, coupon line items, and bonus discount line item. Gift certificate line items are optional and use zero tax rate per default, which can be overwritten. Price adjustments cannot be set because they are either calculated or inherited (depending on the type, the tax rate is either obtained from the related line item or computed as prorate of the basket). API endpoint.s allowing further basket modification: - customer information: PUT /baskets/{basketId}/customer - billing address: PUT /baskets/{basketId}/billing-address - shipments including shipping address and shipping method: POST /baskets/{basketId}/shipments - product items: POST /baskets/{basketId}/items - coupon items: POST /baskets/{basketId}/coupons - gift certificate items: POST /baskets/{basketId}/gift-certificates - basket taxation: PUT /baskets/{basketId}/taxes - basket item taxation: PUT /baskets/{basketId}/items/{itemId}/taxes - payment method and card type: POST /baskets/{basketId}/payment-instruments - custom properties: PATCH /baskets/{basketId} Related resource means with which resource you can specify the same data after the basket creation. Identify the basket using the basketId property, which should be integrated into the path of an update request (for example a POST to /baskets/{basketId}/items). A customer must provide a JSON Web Token (JWT), which specifies exactly one customer (it can be a guest or a registered customer). In this case, the resource creates a basket for this customer. The number of baskets which can be created per customer is limited. When a basket is created, it is said to be open. It remains open until either an order is created from it using a POST to resource /orders, or it is deleted using a DELETE to resource /baskets/{basketId}. Each customer can have just one open basket. Custom properties in the form c_<CUSTOM_NAME> are supported. A custom property must correspond to a custom attribute (<CUSTOM_NAME>) defined for the basket system object, and its value must be valid for that custom attribute. This operation makes an HTTP POST request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Tax Mode |  Enumeration, one of:
  * INTERNAL
  * EXTERNAL

| Tax Mode | INTERNAL  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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 Coupon To Basket
`<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-coupons-by-version-organization-id-basket-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:create-checkout-shopper-baskets-organizations-baskets-gift-certificate-items-by-version-organization-id-basket-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:create-checkout-shopper-baskets-organizations-baskets-items-by-version-organization-id-basket-id>`
Adds new items to a basket. The added items are associated with the specified shipment. If no shipment id is specified, the added items are associated with the default shipment. Considered values from the request body, for each item are: - productId: a valid product ID. This is the ID of the product to be added to the basket. If the product is already in the basket, the API either increments the quantity of the existing product line item or creates a new product line item, based on the site preference 'Add Product Behavior'. For option products and product bundles containing base products, the API creates a new product line item regardless of the site preference. - shipmentId: a valid shipment ID (optional). This is the ID of the shipment in which the product item is created. - quantity: a number between 0.01 and 999. This is the quantity of the product to order. - inventoryId: a valid inventory ID (optional). This is the ID of the inventory from which the item is allocated. - bonusDiscountLineItemId: a valid bonus discount line item ID (optional). This is the ID of the bonus discount line item for which the added product is a selected bonus product. - optionItems/optionValueId: a valid option value ID. This is an option value for an option item of an option product. This is only possible if the product item is an option product. To set option values, you must specify a collection of option items in the optionItems property. These option items must contain optionId and optionValueId. Also, the values you specify must be valid for the option product that this product item represents. Otherwise, the server throws an InvalidProductOptionItemException or an InvalidProductOptionValueItemException. - custom properties in the form c_<CUSTOM_NAME>: the custom property must correspond to a custom attribute (<CUSTOM_NAME>) defined for ProductLineItem. The value of this property must be valid for the type of custom attribute defined for ProductLineItem. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:create-checkout-shopper-baskets-organizations-baskets-payment-instruments-by-version-organization-id-basket-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-checkout-shopper-baskets-organizations-baskets-shipments-by-version-organization-id-basket-id>`
Creates a new shipment for a basket. The created shipment is initialized with values provided in the body document and can be updated with further data API calls. Considered from the body are the following properties if specified: - the ID - the shipping address - the shipping method - gift boolean flag - gift message - custom properties 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-checkout-shopper-orders-organizations-orders-by-version-organization-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-checkout-shopper-orders-organizations-orders-payment-instruments-by-version-organization-id-order-no>`
Adds a payment instrument to an order. Details: The payment instrument is added with the provided details. The payment method must be applicable for the order see GET /baskets/{basketId}/payment-methods, if the payment method is 'CREDIT_CARD' a paymentCard must be specified in the request. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Order No | The order number of the order to be modified.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:create-customer-shopper-customers-organizations-customers-by-version-organization-id>`
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 endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-payment-instruments-by-version-organization-id-customer-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id>`
Adds an item to the customer’s product list. Considered values from the request body are: type: A valid type, mandatory. This is the type of the item to be added to the customer’s product. list. priority: This is the priority of the item to be added to the customer’s product list. public: This is the flag whether the item to be added to the customer’s product list is public. product_id: A valid product ID, used for product item type only. This is the ID (SKU) of the product related to the item to be added to the customer’s product list. It is mandatory for product item type, and it must be a valid product id, otherwise ProductListProductIdMissingException or ProductListProductNotFoundException will be thrown. quantity: Used for product item type only. This is the quantity of the item to be added to the customer’s product list. custom properties in the form c_<CUSTOM_NAME>: The custom property must correspond to a custom attribute (<CUSTOM_NAME>) defined for ProductListItem. The value of this property must be valid for the type of custom attribute defined for ProductListItem. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
The product list ID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:create-pricing-shopper-gift-certificates-organizations-gift-certificate-by-version-organization-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:delete-checkout-shopper-baskets-organizations-baskets-coupons-by-version-organization-id-basket-id-coupon-item-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Coupon Item Id | The ID of the coupon item to be removed.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:delete-checkout-shopper-baskets-organizations-baskets-gift-certificate-items-by-version-organization-id-basket-id-gift-certificate-item-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Gift Certificate Item Id | the ID of the gift certificate item to be updated.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:delete-checkout-shopper-baskets-organizations-baskets-items-by-version-organization-id-basket-id-item-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
The ID of the item to be updated.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:delete-checkout-shopper-baskets-organizations-baskets-payment-instruments-by-version-organization-id-basket-id-payment-instrument-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Payment Instrument Id | Payment Instrument Id  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:delete-checkout-shopper-baskets-organizations-baskets-shipments-by-version-organization-id-basket-id-shipment-id>`
Removes a specified shipment and all associated product, gift certificate, shipping, and price adjustment line items from a basket. It is not allowed to remove the default shipment. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Shipment Id | The ID of the shipment to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:delete-checkout-shopper-orders-organizations-orders-payment-instruments-by-version-organization-id-order-no-payment-instrument-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Order No | The order number of the order to be modified.  
Payment Instrument Id | the ID of the payment instrument to be updated.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


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


## Invalidate Customer Auth
`<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-actions-logout-by-version-organization-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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:delete-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id-address-name>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
Address Name | The name of the address to update.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-payment-instruments-by-version-organization-id-customer-id-payment-instrument-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
Payment Instrument Id | The ID of the payment instrument to be retrievedCustomer.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id-list-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
The product list ID.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id-item-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The product list ID.  
Customer Id | The customer ID.  
The ID of the product list item to update.  
Organization Id | Organization Id  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config
| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-checkout-shopper-baskets-organizations-baskets-payment-methods-by-version-organization-id-basket-id>`
Gets applicable payment methods for an existing basket considering the open payment amount only. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-checkout-shopper-baskets-organizations-baskets-shipments-shipping-methods-by-version-organization-id-basket-id-shipment-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Shipment Id | The ID of the shipment to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream
## Get Shipping Methods For Shipment
`<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-shipments-shipping-methods-by-version-organization-id-basket-id-shipment-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Shipment Id | The ID of the shipment to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-checkout-shopper-orders-organizations-orders-by-version-organization-id-order-no>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Order No | The order number of the order to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-checkout-shopper-orders-organizations-orders-payment-methods-by-version-organization-id-order-no>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Order No | The order number of the order to be modified.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id-address-name>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
Address Name | The name of the address to update.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-baskets-by-version-organization-id-customer-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-by-version-organization-id-customer-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-orders-by-version-organization-id-customer-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
Cross Sites | Cross Sites  
Maximum records to retrieve per request, not to exceed 50. Defaults to 10.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-payment-instruments-by-version-organization-id-customer-id-payment-instrument-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
Payment Instrument Id | The ID of the payment instrument to be retrievedCustomer.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id-list-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Customer Id | The customer ID.  
The product list ID.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id-item-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The product list ID.  
Customer Id | The customer ID.  
The ID of the product list item to update.  
Organization Id | Organization Id  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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 Lists By Search Term
`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-product-lists-by-version-organization-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
The email address of the customer the product lists belong to.  
First Name | The first name of the customer the product lists belong to.  
Last Name | The last name of the customer the product lists belong to.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-customer-shopper-customers-organizations-product-lists-by-version-organization-id-list-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
The ID of the list.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-customer-shopper-customers-organizations-product-lists-items-by-version-organization-id-list-id-item-id>`
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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
The ID of the list.  
The ID of the item.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-pricing-shopper-promotions-organizations-promotions-by-version-organization-id>`
Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules. This operation makes an HTTP GET request to the /pricing/shopper-promotions/{version}/organizations/{organizationId}/promotions endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-pricing-shopper-promotions-organizations-promotions-campaigns-by-version-organization-id-campaign-id>`
Handles get promotion by filter criteria. Returns an array of enabled promotions matching the specified filter criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date range by providing start_date and end_date parameters. Both parameters are required to specify a date range, as omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled promotions, since the server does not consider promotion qualifiers or schedules. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Campaign Id | Find the promotions assigned to this campaign (mandatory).  
Start Date | The start date of the promotion in ISO8601 date time format: yyyy-MM-dd''T''HH:mmZ  
End Date | The end date of the promotion in ISO8601 date time format: yyyy-MM-dd''T''HH:mmZ  
currency | 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  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-product-shopper-products-organizations-categories-by-version-organization-id>`
When you use the URL template, the server returns multiple categories (a result object of category documents). You can use this template as a convenient way of obtaining multiple categories in a single request, instead of issuing separate requests for each category. You can specify up to 50 multiple IDs. You must enclose the list of IDs in parentheses. If a category identifier contains parenthesis or the separator sign, you must URL encode the character. The server only returns online categories. This operation makes an HTTP GET request to the /product/shopper-products/{version}/organizations/{organizationId}/categories endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
The comma separated list of category IDs (max 50).  
Enumeration, one of: | 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.  
The locale context.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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
| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-product-shopper-products-organizations-categories-by-version-organization-id-id>`
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. The server only returns online categories. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
The ID of the requested category.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-product-shopper-products-organizations-products-by-version-organization-id>`
Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Alongwith product details, the availability, images, price, promotion and variations data for the valid products will be included as appropriate. This operation makes an HTTP GET request to the /product/shopper-products/{version}/organizations/{organizationId}/products endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
The IDs of the requested products (comma-separated, max 24 IDs).  
Inventory Ids | The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).  
currency | The currency mnemonic specified for price.  
The locale context.  
All Images | The flag that indicates whether to retrieve the whole image model for the requested product.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters | Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.  
Custom Headers | Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines whether to send the request using streaming. If the value is set to `AUTO`, the best strategy is automatically determined based on the content of the request.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Customer Auth Config


### 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-shopper-products-organizations-products-by-version-organization-id-id>`
Allows access to product details for a single product ID. Only products that are online and assigned to a site catalog are returned. Along with product details, the availability,images,price,bundled_products,set_products,recommedations,productoptions,variation and promotion data for the products will be included as appropriate. 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  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
The ID of the requested product.  
Inventory Ids | The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).  
currency | The currency mnemonic specified for price.  
The locale context.  
All Images | The flag that indicates whether to retrieve the whole image model for the requested product.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream