# mulesoft Salesforce Commerce Cloud B2C Shop API Connector - Full Documentation --- product: Salesforce Commerce Cloud B2C Shop API Connector version: 2.1 is-latest-version: true --- # B2C Shop Connector 2.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt > [!NOTE] No further updates or new versions are planned for this connector. Use > [Anypoint Connector for HTTP (HTTP Connector)](https://docs.mulesoft.com/http-connector/latest/) instead. Refer to the > [migration guide](https://developer.salesforce.com/docs/commerce/commerce-api/guide/migrate-mulesoft-http-connector.html). Anypoint Connector for Salesforce Commerce Cloud B2C Shop APIs (B2C Shop Connector) enables a client to interact with the Commerce Cloud B2C API system as either a shop customer or as an agent shopping on behalf of a customer. For information about compatibility and fixed issues, see Commerce Cloud B2C Shop Connector Release Notes. > [!NOTE] Salesforce Commerce Cloud B2C Data Connector and Salesforce Commerce Cloud B2C Shop > Connector cannot be run in the same application. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce Commerce Cloud Shop API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - The Commerce Cloud B2C Shop Connector target resource - Anypoint Platform - Anypoint Studio version 7.1 or later - Salesforce-provided Commerce Cloud credentials (such as Client Id, Client Secret, and Scopes) necessary to access Shop API. ## Common Uses for the Connector These are some common use cases for B2C Shop Connector: - Create a basket - Add items to a basket - Add shipping details - Place an order Check the [Examples](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-examples) for a simple use case. ## Audience - New user To create your Mule app, see: - [Using Anypoint Studio to Configure Commerce Cloud B2C Connector](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-studio) - [Examples](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-examples) - Advanced user - Read the following: - [XML and Maven Support](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-xml-maven) - [Examples](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-examples) ## Connection Types B2C Shop Connector connections use the following authentication types: - Customers Auth Uses a Bearer Token, which is generated using the **Authorize Customer** operation - OAuth 2.0 Delegates user authentication to the service hosting the user account For information about configuring authentication types, see [Using Anypoint Studio to Configure Commerce Cloud B2C Shop Connector](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-studio). ## Next Step After you complete the prerequisites and try the templates and examples, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Commerce Cloud B2C Shop API Connector version: 2.1 is-latest-version: true --- # Commerce Cloud B2C Shop Connector 2.1 - Troubleshoot > For the full documentation index, see: https://docs.mulesoft.com/llms.txt There are a few scenarios when the Commerce Cloud B2C Shop Connector might return 4XX errors. **400 Bad Request** Commerce Cloud B2C Shop Connector might return a `400 Bad Request` error response if the URI parameters, such as Organization Id, Site Id, and Version parameters are not passed with the proper values, for example: - The parameters are passed with the wrong values. - The parameters are passed with an extra space. ## Solution Correct and pass the proper values. **401 Unauthorized** Commerce Cloud B2C Shop Connector might return a `401 Unauthorized` error response in the following cases: - The Client Id used in the configuration is incorrect. - The Client Secret used in the configuration is incorrect. ## Solutions - Correct and pass the proper values for the Client ID and Client Secret. - If the Client Id and Client Secret are both correct and you are still getting the error, contact the Commerce Cloud team. **403 Forbidden** Commerce Cloud B2C Shop Connector might return a `403 Forbidden` error response if the Scopes used in the configuration are incorrect. ## Solution - Correct and pass the proper values for the Scopes. **405 Method Not Allowed** Commerce Cloud B2C Shop Connector method returns a `405 Method Not Allowed` error when a resource that previously supported an HTTP POST got removed and had its HTTP GET method deprecated because of business decisions. ## Solution - Contact the Commerce Cloud team. **415 Unsupported Media Type** Commerce Cloud B2C Shop Connector might return a `415 unsupported media type` error response in these cases: - The body type the user is passing to the connector `Content` parameter does not match the required input type. - Expression mode is enabled and the output type of the body is not defined as `application/json`. ## Solution - Use the correct type for the body. - Enable Expression mode and define the output type of the body as `application/json`. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) - [Known Issues](https://help.salesforce.com/s/issues) --- product: Salesforce Commerce Cloud B2C Shop API Connector version: 2.1 is-latest-version: true --- # Commerce Cloud B2C Shop Connector 2.1 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio. If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. When you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/commerce-cloud-shopper-api http://www.mulesoft.org/schema/mule/commerce-cloud-shopper-api/current/mule-commerce-cloud-shopper-api.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors commerce-cloud-shopperapi x.x.x mule-plugin ``` Replace the contents of the `` tag with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `Commerce Cloud B2C Shop Connector`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-examples). ## See Also [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Commerce Cloud B2C Shop API Connector version: 2.1 is-latest-version: true --- # Commerce Cloud B2C Shop Connector 2.1 Example > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Commerce Cloud 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 for the connector to perform. Commerce Cloud B2C Shop Connector supports two different types of configuration. This example uses the Customer Auth Connection Provider configuration. After successful execution of the Get Customer operation we get the customer result. To get an access token, you can use **Authenticate Customer** and **Get Access Token** (if you are using B2C Shop Connector 2.1 and later) or you can use **Authorize Customer**. **Authenticate Customer** and **Get Access Token** 1. Create a new Mule application in Anypoint Studio, configuring port 8081 as HTTP Listener and the path, for example, `/login`. 2. Before you can use **Authenticate Customer**, you must prepare a redirect URI for handling the redirect from SLAS that contains the shopper USID and authorization code. The redirect URI must be publicly accessible, so you must use a tool such as webhook.site or ngrok to expose a localhost endpoint externally. 3. Drag the **Authenticate Customer** operation from the Mule palette to the flow. 4. For registered users, you must register the token using the code from **Authenticate Customer** callback response. Create a new HTTP Listener on port 8081 with the path `/register`. 5. Drag the **Get Access Token** operation from the Mule palette to the flow with the path `/register`. 6. Obtain the required parameters for the **Authenticate Customer** and **Get Access Token** operations from Postman. 7. For both of the operations, select the Commerce Cloud B2C Shop Connector Shopper Token Config from B2C Shop Connector and configure the required values or add a new configuration by clicking the green plus (+) symbol. 8. After entering all the required parameters, save the Mule project. 9. Run the project as a Mule application by right-clicking the project name in **Package Explorer** and selecting **Run As > Mule Application**. 10. Navigate to `http://localhost:8081/auth`, open Postman, and check the response. You should see an empty body in Postman with the status 200, which means a callback request is sent to the redirect URI. 11. Retrieve the code query parameter from the callback request. This step differs based on how you handle the OAuth2 callback. 12. Use the code in the second request to construct a new request to **Get Access Token**. 13. Navigate to `http://localhost:8081/register`, open Postman, and check the response. After a successful call, retrieve the access and refresh token to use in other SCAPI calls. Provide this JWT token from Postman as an authorization header parameter to perform operations. **Authorize Customer** 1. Perform an **Authorize Customer** operation to get the Shopper JWT token. 2. Create a new Mule application in Anypoint Studio (Studio), configuring port 8081 as HTTP Listener and the path as "/customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/login". ![Authorize Customer operation config in General tab](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-authorize-customer-http-listener-config.jpg) 3. Add Operation, "Authorize Customer" from the palette to the flow. ![Authorize Customer operation dragged to the flow](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-authorize-customer.png) 4. Obtain the required parameters for Authorize Customer operation from the postman. ![Authorize Customer operation fields configuration](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-authorize-customer-body.jpg) 5. Select the Commerce Cloud B2C Shop Connector Shopper Token Config from Commerce Cloud B2C Shop Connector and configure it with the required values or add a new configuration by clicking the green plus (+) symbol. ![General tab in Global config window for token](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-shopper-token-config.jpg) 6. After entering all the required parameters, save the Mule project. 7. Run the project as a Mule application by right-clicking the project name in Package Explorer and selecting Run As > Mule Application. 8. Navigate to `http://localhost:8081/customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/login`, open Postman, and check the response. 9. You should see the JWT Token in the response header. Provide this JWT Token from Postman as authorization header parameter to perform operations. **Get Customer** 1. Create a new Mule application in Anypoint Studio (Studio), configuring port 8081 as HTTP Listener and the path as "/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}". ![HTTP listener config panel in General tab](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-http-listener-config.jpg) 2. Add Operation, "Get Customer" from the palette to the flow. ![Get Customer operation dragged to the flow](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-get-customer-flow.png) 3. Obtain the required parameters for Get Customer operation from the postman. ![Get Customer operation fields configuration](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-get-customer-body.jpg) 4. Select the Commerce Cloud B2C Shop Connector Config from Commerce Cloud B2C Shop Connector and configure it with the required values or add a new configuration by clicking the green plus (+) symbol. ![General tab in Global config window for auth config](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-customer-auth-config.jpg) 5. In the above image we are using the authentication token from Authorize Customer as Authorization parameter value. 6. After entering the all required parameters, save the Mule project. 7. Run the project as a Mule application by right-clicking the project name in Package Explorer and selecting Run As > Mule Application. 8. Navigate to `http://localhost:8081/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}`, open Postman, pass the Shopper JWT Token from the header and check the response. 9. You should see the customer details in the output. ## XML for Authenticate Customer and Get Access Token Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml # guest_flow.xml ``` ```xml # registered_flow.xml ``` ## Steps for Authenticate Customer and Get Access Token 1. Create new Mule application. 2. Click the Configuration XML tab at the base of the canvas. 3. Copy and paste the above code. 4. Save the project. 5. Run the project as a Mule application by right-clicking the project name in Package Explorer and selecting Run As > Mule Application. 6. Navigate to `http://localhost:8081/login` for the guest flow and `http://localhost:8081/register` for the registered user flow, open Postman, and check the response. 7. You should see the JWT token in the response header. Provide this JWT token from Postman as an authorization header parameter to perform operations. ## XML for Authorize Customer Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule app: ```xml ``` ## Steps for Authorize Customer 1. Create new Mule Application. 2. Click the Configuration XML tab at the base of the canvas. 3. Copy and paste the above code. 4. Save the project. 5. Run the project as a Mule application by right-clicking the project name in Package Explorer and selecting Run As > Mule Application. 6. Navigate to `http://localhost:8081/customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/login`, open Postman, and check the response. 7. You should see the JWT Token in the response header. Provide this JWT Token from Postman as authorization header parameter to perform operations. ## XML for Get Customer Paste this code into your Studio XML editor to quickly load the flow for this example into your Mule app: ```xml xml ``` ## Steps for Get Customer 1. Create new Mule Application. 2. Click the Configuration XML tab at the base of the canvas. 3. Copy and paste the above code. 4. Save the project. 5. Run the project as a Mule application by right-clicking the project name in Package Explorer and selecting Run As > Mule Application. 6. Navigate to `http://localhost:8081/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}`, open Postman, pass the Shopper JWT Token from the header and check the response. 7. You should see the customer details in the output. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Commerce Cloud B2C Shop API Connector version: 2.1 is-latest-version: true --- # Commerce Cloud B2C Shop Connector 2.1 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt > [!NOTE] 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Response Timeout

Number

The timeout for request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

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

AUTO

Name

String

The identifier of this element used to reference it in other components

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before 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
NameTypeDescriptionDefault ValueRequired

Default Headers

Query Parameters

Connection Timeout

Number

Timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections that will be kept open at the same time

-1

Connection Idle Timeout

Number

Timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

Proxy Config

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Whether or not to stream received responses.

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Base Uri

String

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](#UpdateCheckoutShopperBasketsOrganizationsBasketsPriceBooksByVersionOrganizationIdBasketId) - [Add Taxes For Basket](#UpdateCheckoutShopperBasketsOrganizationsBasketsTaxesByVersionOrganizationIdBasketId) - [Add Taxes For Basket Item](#UpdateCheckoutShopperBasketsOrganizationsBasketsItemsTaxesByVersionOrganizationIdBasketIdItemId) - [Authorize Trusted System](#CreateCustomerShopperCustomersOrganizationsCustomersTrustedSystemActionsLoginByVersionOrganizationId) - [Get Price Books For Basket](#GetCheckoutShopperBasketsOrganizationsBasketsPriceBooksByVersionOrganizationIdBasketId) - [Get Reset Password Token](#CreateCustomerShopperCustomersOrganizationsCustomersPasswordActionsCreateResetTokenByVersionOrganizationId) - [Get Taxes From Basket](#GetCheckoutShopperBasketsOrganizationsBasketsTaxesByVersionOrganizationIdBasketId) - [Get Taxes From Order](#GetCheckoutShopperOrdersOrganizationsOrdersTaxesByVersionOrganizationIdOrderNo) - [Reset Password](#CreateCustomerShopperCustomersOrganizationsCustomersPasswordActionsResetByVersionOrganizationId) ## Customer Auth Config
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Response Timeout

Number

The timeout for request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

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

AUTO

Name

String

The identifier of this element used to reference it in other components

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

### Connection Types #### Shopper Connection Provider ##### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Query Parameters

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections that will be kept open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

Proxy Config

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Whether or not received responses should be streamed

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response is stored.

-1

Base Uri

String

Each instance, or tenant, gets its own base URI.

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

Authorization

String

Shopper JWT token

x

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 Coupon To Basket](#CreateCheckoutShopperBasketsOrganizationsBasketsCouponsByVersionOrganizationIdBasketId) - [Add Gift Certificate Item To Basket](#CreateCheckoutShopperBasketsOrganizationsBasketsGiftCertificateItemsByVersionOrganizationIdBasketId) - [Add Item To Basket](#CreateCheckoutShopperBasketsOrganizationsBasketsItemsByVersionOrganizationIdBasketId) - [Add Payment Instrument To Basket](#CreateCheckoutShopperBasketsOrganizationsBasketsPaymentInstrumentsByVersionOrganizationIdBasketId) - [Create Basket](#CreateCheckoutShopperBasketsOrganizationsBasketsByVersionOrganizationId) - [Create Customer Address](#CreateCustomerShopperCustomersOrganizationsCustomersAddressesByVersionOrganizationIdCustomerId) - [Create Customer Payment Instrument](#CreateCustomerShopperCustomersOrganizationsCustomersPaymentInstrumentsByVersionOrganizationIdCustomerId) - [Create Customer Product List](#CreateCustomerShopperCustomersOrganizationsCustomersProductListsByVersionOrganizationIdCustomerId) - [Create Customer Product List Item](#CreateCustomerShopperCustomersOrganizationsCustomersProductListsItemsByVersionOrganizationIdCustomerIdListId) - [Create Order](#CreateCheckoutShopperOrdersOrganizationsOrdersByVersionOrganizationId) - [Create Payment Instrument For Order](#CreateCheckoutShopperOrdersOrganizationsOrdersPaymentInstrumentsByVersionOrganizationIdOrderNo) - [Create Shipment For Basket](#CreateCheckoutShopperBasketsOrganizationsBasketsShipmentsByVersionOrganizationIdBasketId) - [Delete Basket](#DeleteCheckoutShopperBasketsOrganizationsBasketsByVersionOrganizationIdBasketId) - [Delete Customer Payment Instrument](#DeleteCustomerShopperCustomersOrganizationsCustomersPaymentInstrumentsByVersionOrganizationIdCustomerIdPaymentInstrumentId) - [Delete Customer Product List](#DeleteCustomerShopperCustomersOrganizationsCustomersProductListsByVersionOrganizationIdCustomerIdListId) - [Delete Customer Product List Item](#DeleteCustomerShopperCustomersOrganizationsCustomersProductListsItemsByVersionOrganizationIdCustomerIdListIdItemId) - [Get Basket](#GetCheckoutShopperBasketsOrganizationsBasketsByVersionOrganizationIdBasketId) - [Get Categories](#GetProductShopperProductsOrganizationsCategoriesByVersionOrganizationId) - [Get Category](#GetProductShopperProductsOrganizationsCategoriesByVersionOrganizationIdId) - [Get Customer](#GetCustomerShopperCustomersOrganizationsCustomersByVersionOrganizationIdCustomerId) - [Get Customer Address](#GetCustomerShopperCustomersOrganizationsCustomersAddressesByVersionOrganizationIdCustomerIdAddressName) - [Get Customer Baskets](#GetCustomerShopperCustomersOrganizationsCustomersBasketsByVersionOrganizationIdCustomerId) - [Get Customer Orders](#GetCustomerShopperCustomersOrganizationsCustomersOrdersByVersionOrganizationIdCustomerId) - [Get Customer Payment Instrument](#GetCustomerShopperCustomersOrganizationsCustomersPaymentInstrumentsByVersionOrganizationIdCustomerIdPaymentInstrumentId) - [Get Customer Product List](#GetCustomerShopperCustomersOrganizationsCustomersProductListsByVersionOrganizationIdCustomerIdListId) - [Get Customer Product List Item](#GetCustomerShopperCustomersOrganizationsCustomersProductListsItemsByVersionOrganizationIdCustomerIdListIdItemId) - [Get Customer Product Lists](#GetCustomerShopperCustomersOrganizationsCustomersProductListsByVersionOrganizationIdCustomerId) - [Get Gift Certificate](#CreatePricingShopperGiftCertificatesOrganizationsGiftCertificateByVersionOrganizationId) - [Get Order](#GetCheckoutShopperOrdersOrganizationsOrdersByVersionOrganizationIdOrderNo) - [Get Payment Methods For Basket](#GetCheckoutShopperBasketsOrganizationsBasketsPaymentMethodsByVersionOrganizationIdBasketId) - [Get Payment Methods For Order](#GetCheckoutShopperOrdersOrganizationsOrdersPaymentMethodsByVersionOrganizationIdOrderNo) - [Get Product](#GetProductShopperProductsOrganizationsProductsByVersionOrganizationIdId) - [Get Product List Item](#GetCustomerShopperCustomersOrganizationsProductListsItemsByVersionOrganizationIdListIdItemId) - [Get Products](#GetProductShopperProductsOrganizationsProductsByVersionOrganizationId) - [Get Promotions](#GetPricingShopperPromotionsOrganizationsPromotionsByVersionOrganizationId) - [Get Promotions For Campaign](#GetPricingShopperPromotionsOrganizationsPromotionsCampaignsByVersionOrganizationIdCampaignId) - [Get Public Product List](#GetCustomerShopperCustomersOrganizationsProductListsByVersionOrganizationIdListId) - [Get Public Product Lists By Search Term](#GetCustomerShopperCustomersOrganizationsProductListsByVersionOrganizationId) - [Get Search Suggestions](#GetSearchShopperSearchOrganizationsSearchSuggestionsByVersionOrganizationId) - [Get Shipping Methods For Shipment](#GetCheckoutShopperBasketsOrganizationsBasketsShipmentsShippingMethodsByVersionOrganizationIdBasketIdShipmentId) - [Invalidate Customer Auth](#DeleteCustomerShopperCustomersOrganizationsCustomersActionsLogoutByVersionOrganizationId) - [Logout Customer](#GetShopperAuthOrganizationsOauth2LogoutByVersionOrganizationId) - [Product Search](#GetSearchShopperSearchOrganizationsProductSearchByVersionOrganizationId) - [Register Customer](#CreateCustomerShopperCustomersOrganizationsCustomersByVersionOrganizationId) - [Remove Coupon From Basket](#DeleteCheckoutShopperBasketsOrganizationsBasketsCouponsByVersionOrganizationIdBasketIdCouponItemId) - [Remove Customer Address](#DeleteCustomerShopperCustomersOrganizationsCustomersAddressesByVersionOrganizationIdCustomerIdAddressName) - [Remove Gift Certificate Item From Basket](#DeleteCheckoutShopperBasketsOrganizationsBasketsGiftCertificateItemsByVersionOrganizationIdBasketIdGiftCertificateItemId) - [Remove Item From Basket](#DeleteCheckoutShopperBasketsOrganizationsBasketsItemsByVersionOrganizationIdBasketIdItemId) - [Remove Payment Instrument From Basket](#DeleteCheckoutShopperBasketsOrganizationsBasketsPaymentInstrumentsByVersionOrganizationIdBasketIdPaymentInstrumentId) - [Remove Payment Instrument From Order](#DeleteCheckoutShopperOrdersOrganizationsOrdersPaymentInstrumentsByVersionOrganizationIdOrderNoPaymentInstrumentId) - [Remove Shipment From Basket](#DeleteCheckoutShopperBasketsOrganizationsBasketsShipmentsByVersionOrganizationIdBasketIdShipmentId) - [Update Basket](#PatchCheckoutShopperBasketsOrganizationsBasketsByVersionOrganizationIdBasketId) - [Update Billing Address For Basket](#UpdateCheckoutShopperBasketsOrganizationsBasketsBillingAddressByVersionOrganizationIdBasketId) - [Update Customer](#PatchCustomerShopperCustomersOrganizationsCustomersByVersionOrganizationIdCustomerId) - [Update Customer Address](#PatchCustomerShopperCustomersOrganizationsCustomersAddressesByVersionOrganizationIdCustomerIdAddressName) - [Update Customer For Basket](#UpdateCheckoutShopperBasketsOrganizationsBasketsCustomerByVersionOrganizationIdBasketId) - [Update Customer Password](#UpdateCustomerShopperCustomersOrganizationsCustomersPasswordByVersionOrganizationIdCustomerId) - [Update Customer Product List](#PatchCustomerShopperCustomersOrganizationsCustomersProductListsByVersionOrganizationIdCustomerIdListId) - [Update Customer Product List Item](#PatchCustomerShopperCustomersOrganizationsCustomersProductListsItemsByVersionOrganizationIdCustomerIdListIdItemId) - [Update Gift Certificate Item In Basket](#PatchCheckoutShopperBasketsOrganizationsBasketsGiftCertificateItemsByVersionOrganizationIdBasketIdGiftCertificateItemId) - [Update Item In Basket](#PatchCheckoutShopperBasketsOrganizationsBasketsItemsByVersionOrganizationIdBasketIdItemId) - [Update Payment Instrument For Order](#PatchCheckoutShopperOrdersOrganizationsOrdersPaymentInstrumentsByVersionOrganizationIdOrderNoPaymentInstrumentId) - [Update Shipment For Basket](#PatchCheckoutShopperBasketsOrganizationsBasketsShipmentsByVersionOrganizationIdBasketIdShipmentId) - [Update Shipping Address For Shipment](#UpdateCheckoutShopperBasketsOrganizationsBasketsShipmentsShippingAddressByVersionOrganizationIdBasketIdShipmentId) - [Update Shipping Method For Shipment](#UpdateCheckoutShopperBasketsOrganizationsBasketsShipmentsShippingMethodByVersionOrganizationIdBasketIdShipmentId) ## Shopper Token Config
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Response Timeout

Number

The timeout for request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

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

AUTO

Name

String

The identifier of this element used to reference it in other components

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

### Connection Types #### Shopper Token Connection Provider ##### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Query Parameters

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections that will be kept open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

Proxy Config

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Whether or not received responses should be streamed

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Base Uri

String

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 - [Authenticate Customer](#CreateShopperAuthOrganizationsOauth2LoginByVersionOrganizationId) - [Authorize Customer](#CreateCustomerShopperCustomersOrganizationsCustomersActionsLoginByVersionOrganizationId) - [Get Access Token](#CreateShopperAuthOrganizationsOauth2TokenByVersionOrganizationId) ## Operations ## Get Reset Password Token `` Get reset password token. This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/create-reset-token endpoint.. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable in which to store the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Am Oauth2 Config](#AmOauth2Config) ### 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 `` Reset customer password. This operation makes an HTTP POST request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/reset endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

Custom Query Parameters

Object

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

Object

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

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Am Oauth2 Config](#AmOauth2Config) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Content

Binary

Content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Am Oauth2 Config](#AmOauth2Config) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Am Oauth2 Config](#AmOauth2Config) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Am Oauth2 Config](#AmOauth2Config) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Order No

String

The order number of the order to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Am Oauth2 Config](#AmOauth2Config) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Item Id

String

The ID of the item to be updated.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Am Oauth2 Config](#AmOauth2Config) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Am Oauth2 Config](#AmOauth2Config) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Am Oauth2 Config](#AmOauth2Config) ### 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 `` 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\_ are supported. A custom property must correspond to a custom attribute () 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Tax Mode

Enumeration, one of:

  • INTERNAL

  • EXTERNAL

Tax Mode

INTERNAL

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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\_: the custom property must correspond to a custom attribute () 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Order No

String

The order number of the order to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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\_: The custom property must correspond to a custom attribute () 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

List Id

String

The product list ID.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` Removes a basket. This operation makes an HTTP DELETE request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Coupon Item Id

String

The ID of the coupon item to be removed.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Gift Certificate Item Id

String

the ID of the gift certificate item to be updated.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Item Id

String

The ID of the item to be updated.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Payment Instrument Id

String

Payment Instrument Id

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Shipment Id

String

The ID of the shipment to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Order No

String

The order number of the order to be modified.

x

Payment Instrument Id

String

the ID of the payment instrument to be updated.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Address Name

String

The name of the address to update.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Payment Instrument Id

String

The ID of the payment instrument to be retrievedCustomer.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

List Id

String

The product list ID.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

List Id

String

The product list ID.

x

Customer Id

String

The customer ID.

x

version

String

version

x

Item Id

String

The ID of the product list item to update.

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` Gets a basket. This operation makes an HTTP GET request to the /checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Shipment Id

String

The ID of the shipment to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` Gets information for an order. This operation makes an HTTP GET request to the /checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Order No

String

The order number of the order to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Order No

String

The order number of the order to be modified.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Address Name

String

The name of the address to update.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Cross Sites

Boolean

Cross Sites

false

from

String

from

until

String

until

status

String

status

Site Id

String

Site Id

x

offset

Number

offset

0

limit

Number

Maximum records to retrieve per request, not to exceed 50. Defaults to 10.

10

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Payment Instrument Id

String

The ID of the payment instrument to be retrievedCustomer.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

List Id

String

The product list ID.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

List Id

String

The product list ID.

x

Customer Id

String

The customer ID.

x

version

String

version

x

Item Id

String

The ID of the product list item to update.

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

email

String

The email address of the customer the product lists belong to.

First Name

String

The first name of the customer the product lists belong to.

Last Name

String

The last name of the customer the product lists belong to.

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

List Id

String

The ID of the list.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

List Id

String

The ID of the list.

x

Item Id

String

The ID of the item.

x

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

ids

String

ids

x

locale

String

locale

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Campaign Id

String

Find the promotions assigned to this campaign (mandatory).

x

Site Id

String

Site Id

x

Start Date

String

The start date of the promotion in ISO8601 date time format: yyyy-MM-dd''T''HH:mmZ

End Date

String

The end date of the promotion in ISO8601 date time format: yyyy-MM-dd''T''HH:mmZ

currency

String

The currency mnemonic specified for price. This parameter is effective only for product suggestions.

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

ids

String

The comma separated list of category IDs (max 50).

x

levels

Enumeration, one of:

  • j_0

  • j_1

  • j_2

Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2.

locale

String

The locale context.

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

id

String

The ID of the requested category.

x

levels

Number

levels

locale

String

locale

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

ids

String

The IDs of the requested products (comma-separated, max 24 IDs).

x

Inventory Ids

String

The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).

currency

String

The currency mnemonic specified for price.

locale

String

The locale context.

All Images

Boolean

The flag that indicates whether to retrieve the whole image model for the requested product.

false

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

id

String

The ID of the requested product.

x

Inventory Ids

String

The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).

currency

String

The currency mnemonic specified for price.

locale

String

The locale context.

All Images

Boolean

The flag that indicates whether to retrieve the whole image model for the requested product.

false

Site Id

String

Site Id

x

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

q

String

The query phrase to search for. For example to search for a product "shirt", type q=shirt.

refine

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.

sort

String

The ID of the sorting option to sort the search hits.

currency

String

The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.

locale

String

locale

offset

Number

offset

0

limit

Number

Maximum records to retrieve per request, not to exceed 200. Defaults to 25.

25

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

q

String

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.

x

limit

Number

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).

5

currency

String

The currency code specified for price. This parameter is effective only for product suggestions.

locale

String

locale

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` Logs out a shopper. This operation makes an HTTP GET request to the /shopper/auth/{version}/organizations/{organizationId}/oauth2/logout endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

version

String

Version.

x

Organization Id

String

Organization ID.

x

Client id

String

SLAS client ID.

x

Refresh token

String

Refresh token given during the access token request.

x

Channel id

String

This field is required if the shopper authenticates using the login endpoint with ECOM.

hint

String

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

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

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

Number

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

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Gift Certificate Item Id

String

the ID of the gift certificate item to be updated.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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\_: a value corresponding to the type defined for custom attribute 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Item Id

String

The ID of the item to be updated.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Shipment Id

String

The ID of the shipment to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Order No

String

The order number of the order to be modified.

x

Payment Instrument Id

String

the ID of the payment instrument to be updated.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Address Name

String

The name of the address to update.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` Updates a customer. This operation makes an HTTP PATCH request to the /customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

List Id

String

The product list ID.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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\_: The custom property must correspond to a custom attribute () 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

List Id

String

The product list ID.

x

Customer Id

String

The customer ID.

x

version

String

version

x

Item Id

String

The ID of the product list item to update.

x

Organization Id

String

Organization Id

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Use As Shipping

Boolean

Use As Shipping

false

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Shipment Id

String

The ID of the shipment to be modified.

x

Use As Billing

Boolean

Use As Billing

false

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Basket Id

String

The ID of the basket to be modified.

x

Shipment Id

String

The ID of the shipment to be modified.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Customer Id

String

The customer ID.

x

Site Id

String

Site Id

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Customer Auth Config](#CustomerAuthConfig) ### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

version

String

version

x

Organization Id

String

Organization Id

x

Client Id

String

Client ID for application identification

x

Site Id

String

Site Id

x

Authorization

String

Authorization:Basic for type credentials Authorization:Bearer for type refresh

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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

Object

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

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Shopper Token Config](#ShopperTokenConfig) ### 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 `` Authenticates an ECOM customer. This operation makes an HTTP POST request to the /shopper/auth/{version}/organizations/{organizationId}/oauth2/login endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

version

String

Version.

x

Organization Id

String

Organization ID.

x

Login

String

Base64-encoded username and password for HTTP Basic authentication.

x

Content

Binary

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Custom Query Parameters

Object

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

Object

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

Number

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

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Shopper Token Config](#ShopperTokenConfig) ### 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 `` 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. > [!IMPORTANT] Use the `channel_id` query parameter because it will be required in the future. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

version

String

Version.

x

Organization Id

String

Organization ID.

x

Authorization

String

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

Binary

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

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

Object

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

Number

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

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • 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

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Shopper Token Config](#ShopperTokenConfig) ### 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
FieldTypeDescriptionDefault ValueRequired

Key

String

x

Value

String

x

### Default Query Param
FieldTypeDescriptionDefault ValueRequired

Key

String

x

Value

String

x

### Proxy
FieldTypeDescriptionDefault ValueRequired

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

### Tls
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

### Trust Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

### Standard Revocation Check
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

### Custom Ocsp Responder
FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### Crl File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

### Reconnect
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

### Http Response Attributes
FieldTypeDescriptionDefault ValueRequired

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

### Repeatable In Memory Stream
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

### Repeatable File Store Stream
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

--- product: Salesforce Commerce Cloud B2C Shop API Connector version: 2.1 is-latest-version: true --- # Upgrading and Migrating Commerce Cloud B2C Shop Connector to Version 2.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade Anypoint Connector for Salesforce Commerce Cloud B2C Shop APIs (B2C Shop Connector) to take advantage of the functionality provided by the Shopper Customer APIs version 0.0.24. ## Supported Upgrade Paths
From VersionTo Version

1.x.x

2.x.x

## Changes in This Release - The connector is updated with the latest Salesforce Commerce B2C Shop APIs. - The Shopper Customer endpoints that did not work in the previous version of the connector are fixed. ## Upgrade Prerequisites Before you perform the upgrade, you must create a backup of your files, data, and configurations in case you need to restore to them. ## Upgrade Steps Follow these steps to perform the upgrade: 1. In Anypoint Studio, create a Mule project. 2. In the **Mule Palette** view, click **Search in Exchange**. 3. In **Add Dependencies to Project**, enter `commerce cloud b2c shop` in the search field. 4. In **Available modules**, select **** and click **Add**. 5. Click **Finish**. 6. Verify that the dependency version is in the `pom.xml` file in the Mule project. Studio upgrades the connector automatically. ### Verify the Upgrade After you install the latest version of the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Verify that there are no problems in the project `pom.xml` file. 3. Test the connection to verify that the operations work. ## Troubleshoot If there are common known issues and errors that occur when upgrading, give troubleshooting tips. ### Revert the Upgrade If it is necessary to revert to the previous version of B2C Shop Connector, change the `connector-name-dependency` dependency version in the project’s `pom.xml` file to the previous version. You must update the project’s `pom.xml` file in Anypoint Studio. --- product: Salesforce Commerce Cloud B2C Shop API Connector version: 2.1 is-latest-version: true --- # Using Anypoint Studio to Configure Commerce Cloud B2C Shop Connector 2.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Commerce Cloud B2C Shop Connector Reference](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-reference). ## Before You Begin To avoid dependency errors, update your Maven `settings.xml` file if needed. See [Maven Reference](https://docs.mulesoft.com/mule-runtime/latest/maven-reference) for more information (Ignore if already done). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Anypoint Connector for Salesforce Commerce Cloud B2C Shop APIs (B2C Shop Connector) to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `commerce cloud b2c shop` in the search field. 3. Click Commerce Cloud B2C Shop Connector in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Commerce Cloud B2C Shop Connector: - **HTTP > Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of HTTP **Listener** in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. For TLS configuration information, see [TLS Configuration](https://docs.mulesoft.com/mule-runtime/latest/tls-configuration). 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. For Reconnection strategy details, see [Reconnection Strategies](https://docs.mulesoft.com/mule-runtime/latest/reconnection-strategy-about). 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for B2C Shop Connector, follow these steps: 1. In the **Mule Palette** view, select **Commerce Cloud B2C Shop Connector** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ![Example of operation dragged to flow](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-add-operation-to-flow.png) ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Commerce Cloud B2C Shop Connector system. Commerce Cloud B2C Shop Connector supports two different types of connection provider: 1. Customer Auth Connection Provider 2. OAuth2 Application Connection Provider To configure the global element for Commerce Cloud B2C Shop Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, configure the connection: - [Customer Auth Connection Provider](#ShopConfiguration_CustomersAuth) - [OAuth2 Application Connection Provider](#ShopConfiguration_Oauth2Application) 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). \+ You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). \+ . On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 1. Click **Test Connection** to confirm that Mule can connect with the specified server. 2. Click **OK**. ### Get the Shopper JWT Token To get the Shopper JWT Token to use for the [**Commerce Cloud B2C Shop Connector Customer Auth Config**](#ShopConfiguration_CustomersAuth): 1. On the **General** tab of the **Global Element Properties** screen, select **Commerce Cloud B2C Shop Connector Shopper Token** and click **OK**. 2. Configure the following parameters:
Field NameValue

Base URI

Parameter base URI. Each instance or tenant gets its own base URI.

![Shopper token global elements properties config window on General tab](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-shopper-token-config.jpg) The XML configuration looks like this: ```xml ``` ### Customer Auth Connection Provider Configuration Before you configure the connection for **Commerce Cloud B2C Shop Connector Customer Auth Config**, [get the Shopper JWT Token](#get-shopper-jwt-token). 1. On the **General** tab of the **Global Element Properties** screen, select **Commerce Cloud B2C Shop Connector Customer Auth Config** and click **OK**. 2. Configure the following parameters:
Field NameValue

Base URI

Parameter base URI. Each instance or tenant has its own base URI.

Authorization

Provide the Commerce Cloud B2C Shopper JWT Token as the authorization parameter.

This example adds the base URI to the application properties file and references it using placeholders: ![Auth config global elements properties config window on General tab](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-customer-auth-config.jpg) 3. Click **Test Connection** to verify the configuration. The XML configuration looks like this: ```xml ``` ### OAuth2 Application Connection Provider 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). 1. On the **General** tab of the **Global Element Properties** screen, select **Commerce Cloud B2C Shop Connector Config** and click **OK**. 2. Configure the following parameters:
Field NameValue

Base Uri

Access API URL

Client Id

ID of the client account created with Salesforce Commerce Cloud

Client Secret

Secret of the client account created with Salesforce Commerce Cloud

Token url

Access token URL

Scopes

Scopes for access

![Commerce Cloud B2C Shop Connector Config with values for the OAuth 2.0 client credentials connection](/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/_images/shop-connector-oauth2-config.jpg) This example adds credentials to the application properties file and references it using placeholders: 3. Click **Test Connection** to verify the configuration. The XML code for the OAuth 2.0 application connection provider configuration looks like this: ```xml ``` ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Configure the Other Connector Fields After you configure a global element and connection information, configure the other fields for the connector. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Connector Reference](https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-reference) - [Salesforce Help](https://help.salesforce.com)