Commerce Cloud B2C Shop Connector 2.1 Reference | MuleSoft Documentation
## 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

| 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


## Product Search
`<commerce-cloud-shopper-api:get-search-shopper-search-organizations-product-search-by-version-organization-id>`
Provides keyword and refinement search functionality for products. Only returns the product ID, link, and name in the product search hit. The search result contains only products that are online and assigned to site catalog. This operation makes an HTTP GET request to the /search/shopper-search/{version}//organizations/{organizationId}/product-search endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
The query phrase to search for. For example to search for a product "shirt", type q=shirt.  
Array of String | Parameter that represents a refinement attribute or values pair. Refinement attribute ID and values are separated by '='. Multiple values are supported by a subset of refinement attributes and can be provided by separating them using a pipe (URL encoded = " | ") i.e. refine=c_refinementColor=red|green|blue. Value ranges can be specified like this: refine=price=(100..500) . Multiple refine parameters can be provided by using the refine as the key i.e refine=price=(0..10)&refine=c_refinementColor=green. The refinements can be a collection of custom defined attributes IDs and the system defined attributes IDs but the search can only accept a total of 9 refinements at a time. The following system refinement attribute ids are supported: cgid: Allows refinement per single category ID. Multiple category ids are not supported. price: Allows refinement per single price range. Multiple price ranges are not supported. pmid: Allows refinement per promotion ID. htypes: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'. orderable_only: Unavailable products are excluded from the search results if true is set. Multiple refinement values are not supported.  
The ID of the sorting option to sort the search hits.  
currency | The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.  
Maximum records to retrieve per request, not to exceed 200. Defaults to 25.  
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 Search Suggestions
`<commerce-cloud-shopper-api:get-search-shopper-search-organizations-search-suggestions-by-version-organization-id>`
Provides keyword search functionality for products, categories, and brands suggestions. Returns suggested products, suggested categories, and suggested brands for the given search phrase. This operation makes an HTTP GET request to the /search/shopper-search/{version}//organizations/{organizationId}/search-suggestions endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
The search phrase (q) for which suggestions are evaluated. Search suggestions are determined when the search phrase input is at least three (default) characters long. The value is configurable in the Business Manager.  
The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).  
currency | The currency code 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


## Logout Customer
`<commerce-cloud-shopper-api:get-shopper-auth-organizations-oauth2-logout-by-version-organization-id>`
Logs out a shopper. This operation makes an HTTP GET request to the /shopper/auth/{version}/organizations/{organizationId}/oauth2/logout endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Version.  
Organization Id | Organization ID.  
Client id | SLAS client ID.  
Refresh token | Refresh token given during the access token request.  
Channel id | This field is required if the shopper authenticates using the `login` endpoint with ECOM.  
Optional field for logging out user sessions. Use `all-sessions` to log out all user sessions. If this field is not used, only the current user session is logged out.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
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 | How long Mule waits for a response to complete before the request times out.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Response Timeout** field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

|  How the connector streams request content to the remote service:
  * `AUTO` (default) Connector automatically uses the best streaming strategy based on the request content.
  * `ALWAYS` Connector always streams the request content.
  * `NEVER` Connector does not stream the request content.

  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| 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


## Update Basket
`<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>`
Updates a basket. Only the currency of the basket, source code, the custom properties of the basket, and the shipping items will be considered. This operation makes an HTTP PATCH request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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
## Update Basket
`<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>`
Updates a basket. Only the currency of the basket, source code, the custom properties of the basket, and the shipping items will be considered. This operation makes an HTTP PATCH request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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


## Update Gift Certificate Item In Basket
`<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-gift-certificate-items-by-version-organization-id-basket-id-gift-certificate-item-id>`
Updates a gift certificate item of an existing basket. This operation makes an HTTP PATCH request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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.  
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


## Update Item In Basket
`<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-items-by-version-organization-id-basket-id-item-id>`
Updates an item in a basket. The following values in the request body are considered by the server: - productId: a valid product ID. The purpose of this value is to exchange a variation of a variation product. - shipmentId: a valid shipment ID. The purpose of this value is to move a product item to another shipment. - quantity: a number between 0 and 999. The purpose of this value is to change quantity of the product item. If quantity is 0, the product item is removed. - optionItems/optionValueId: a valid option value ID. The purpose of this value is to exchange an option value for an option item of an option product. This is only possible if the product item is an option product. To change option values a collection of option items to be changed need to be provided in property optionItems. Those optionItems need to contain optionId and optionValueId. The provided values must be valid for the option product that this product item represents. Otherwise InvalidProductOptionItemException or InvalidProductOptionValueItemException will be thrown. custom properties c_<CUSTOM_NAME>: a value corresponding to the type defined for custom attribute <CUSTOM_NAME> of ProductLineItem. The purpose of this value is to add or change the value of a custom attribute defined for ProductLineItem. This operation makes an HTTP PATCH request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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.  
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
| 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


## Update Shipment For Basket
`<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-shipments-by-version-organization-id-basket-id-shipment-id>`
Updates a shipment for a basket. The 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 PATCH 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.  
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


## Update Payment Instrument For Order
`<commerce-cloud-shopper-api:patch-checkout-shopper-orders-organizations-orders-payment-instruments-by-version-organization-id-order-no-payment-instrument-id>`
Updates a payment instrument of an order. Details: The payment instrument is updated 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 PATCH 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.  
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


## Update Customer Address
`<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id-address-name>`
Updates a customer''s address by address name. This operation makes an HTTP PATCH request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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.  
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


## Update Customer
`<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-by-version-organization-id-customer-id>`
Updates a customer. This operation makes an HTTP PATCH request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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


## Update Customer Product List
`<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id-list-id>`
Changes a product list. Changeable properties are the name, description, and if the list is public. This operation makes an HTTP PATCH request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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


## Update Customer Product List Item
`<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id-item-id>`
Updates an item of a customer’s product list. Considered values from the request body are: priority: This is the priority of the customer’s product list item. public: This is the flag whether the customer’s product list item is public. quantity: This is the quantity of the customer’s product list item. Used for product item type only. 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 PATCH request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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  
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


## Update Billing Address For Basket
`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-billing-address-by-version-organization-id-basket-id>`
Sets the billing address of a basket. This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/billing-address endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Use As Shipping | Use As Shipping  
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
## Update Billing Address For Basket
`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-billing-address-by-version-organization-id-basket-id>`
Sets the billing address of a basket. This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/billing-address endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Basket Id | The ID of the basket to be modified.  
Use As Shipping | Use As Shipping  
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


## Update Customer For Basket
`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-customer-by-version-organization-id-basket-id>`
Sets customer information for an existing basket. This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/customer endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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


## Update Shipping Address For Shipment
`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-shipments-shipping-address-by-version-organization-id-basket-id-shipment-id>`
Sets a shipping address of a specific shipment of a basket. This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-address endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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.  
Use As Billing | Use As Billing  
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


## Update Shipping Method For Shipment
`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-shipments-shipping-method-by-version-organization-id-basket-id-shipment-id>`
Sets a shipping method to a specific shipment of a basket. This operation makes an HTTP PUT request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-method endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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.  
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


## Update Customer Password
`<commerce-cloud-shopper-api:update-customer-shopper-customers-organizations-customers-password-by-version-organization-id-customer-id>`
Updates the customer''s password. This operation makes an HTTP PUT request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/password endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
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  
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


## Authorize Customer
`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-actions-login-by-version-organization-id>`
Obtains a new JSON Web Token (JWT)for a guest or registered customer. Tokens are returned as an HTTP Authorization:Bearer response header entry. These kinds of request are supported, as specified by the type: Type guest - creates a guest (non-authenticated) customer and returns a token for the customer. Request Body for guest : {"type": "guest"} Type credentials - authenticates credentials passed in the HTTP Authorization:Basic request header, returning a token for a successfully authenticated customer, otherwise it throws an AuthenticationFailedException. Request Body for guest : {"type": "credentials"} Type refresh - examines the token passed in the HTTP Authorization:Bearer request header and when valid returns a new token with an updated expiry time. Request Body for guest : {"type": "refresh"} For a request of type credentials: Updates profile attributes for the customer (for example, "last-visited"). Handles the maximum number of failed login attempts. About JWT The token contains 3 sections: The header section (specifies token type and algorithm used), the payload section (contains customer information, client ID, issue, and expiration time), finally the signature section records the token signature. A token is created and returned to the client whenever a registered customer logs in (type "credentials") or a guest customer requests it (type "guest"). The token is returned in the response header as Authorization: Bearer --token-- The client has to include the token in the request header as Authorization: Bearer --token-- in any follow-up request. The server declines any follow-up requests without a token or which cannot be verified based on the token signature or expiration time. A token nearing its expiration time should be exchanged for a new one (type "refresh"). See "API Usage > JWT" for more details on using JWT as an authentication mechanism. This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/login endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Organization Id | Organization Id  
Client Id | Client ID for application identification  
Authorization | Authorization:Basic for type credentials Authorization:Bearer for type refresh  
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
  * Shopper Token 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


## Authenticate Customer
`<commerce-cloud-shopper-api:create-shopper-auth-organizations-oauth2-login-by-version-organization-id>`
Authenticates an ECOM customer. This operation makes an HTTP POST request to the /shopper/auth/{version}/organizations/{organizationId}/oauth2/login endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Version.  
Organization Id | Organization ID.  
Base64-encoded username and password for HTTP Basic authentication.  
Content to use. | `#[payload]`  
Config Ref |  ConfigurationProvider | 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 | How long Mule waits for a response to complete before the request times out.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Response Timeout** field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

|  How the connector streams request content to the remote service:
  * `AUTO` (default) Connector automatically uses the best streaming strategy based on the request content.
  * `ALWAYS` Connector always streams the request content.
  * `NEVER` Connector does not stream the request content.

  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Shopper Token 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
| Retry strategy in case of connectivity errors.  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Shopper Token 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 Access Token
`<commerce-cloud-shopper-api:create-shopper-auth-organizations-oauth2-token-by-version-organization-id>`
Gets a JWT access token and a refresh token for the shopper or guest. This is the second step of the OAuth 2.0 authorization code flow. The client appplication gets an access token through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
When refreshing the access token with a private client ID, the refresh token is not regenerated. However, when refreshing the access token with a public client ID, the refresh token is regenerated. The old refresh token is voided with every refresh call, so the refresh token must be replaced to store the new refresh token.
This operation makes an HTTP POST request to the /shopper/auth/{version}/organizations/{organizationId}/oauth2/token endpoint.
Use the `channel_id` query parameter because it will be required in the future.   
---  
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Version.  
Organization Id | Organization ID.  
Authorization | Base64-encoded string for HTTP Basic authentication. The string is composed of a client ID and a client secret separated by a colon, for example: `clientId:clientSecret`. This field is required unless the grant type is `authorization_code_pkce`.  
Content to use. | `#[payload]`  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
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 | How long Mule waits for a response to complete before the request times out.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Response Timeout** field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

|  How the connector streams request content to the remote service:
  * `AUTO` (default) Connector automatically uses the best streaming strategy based on the request content.
  * `ALWAYS` Connector always streams the request content.
  * `NEVER` Connector does not stream the request content.

  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  * Shopper Token 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


## Types
### Default Header
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Default Query Param
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Proxy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Non Proxy Hosts  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enabled Protocols | A comma separated list of protocols enabled for this context.  
Enabled Cipher Suites | A comma separated list of cipher suites enabled for this context.  
Trust Store  
Key Store  
Revocation Check | 
  * Standard Revocation Check
  * Custom Ocsp Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.  
Password | The password used to protect the trust store.  
The type of store used.  
Algorithm | The algorithm used by the trust store.  
Insecure | If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.  
### Key Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.  
The type of store used.  
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.  
Key Password | The password used to protect the private key.  
Password | The password used to protect the key store.  
Algorithm | The algorithm used by the key store.  
### Standard Revocation Check
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Only End Entities | Only verify the last element of the certificate chain.  
Prefer Crls | Try CRL instead of OCSP first.  
No Fallback | Do not use the secondary checking method (the one not selected before).  
Soft Fail | Avoid verification failure when the revocation server can not be reached or is busy.  
### Custom Ocsp Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The URL of the OCSP responder.  
Cert Alias | Alias of the signing certificate for the OCSP response (must be in the trust store), if present.  
### Crl File
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The path to the CRL file.  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy  
Reconnection Strategy | 
  *   * Reconnect Forever
| The reconnection strategy to use  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often (in ms) to reconnect  
Blocking | If false, the reconnection strategy will run in a separate, non-blocking thread  
How many reconnection attempts to make  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often (in ms) to reconnect  
Blocking | If false, the reconnection strategy will run in a separate, non-blocking thread  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration  
Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the maxIdleTime attribute  
### Http Response Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Status Code  
Reason Phrase  
### Repeatable In Memory Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Initial Buffer Size | This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.  
Buffer Size Increment | This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.  
Max Buffer Size | This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.  
Buffer Unit |  Enumeration, one of: | The unit in which all these attributes are expressed  
### Repeatable File Store Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
In Memory Size | Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.  
Buffer Unit |  Enumeration, one of: | The unit in which maxInMemorySize is expressed