---
schema_version: "1"
id: 2180c0713af43f3cb728db75168dedcaa951b06db4b711c9412f4f47b7ec99b9
title: Commerce Cloud B2C Shop Connector 2.1 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/commerce-cloud-shop-api-connector/latest/shop-api-connector-reference.md
canonical_url: https://docs.mulesoft.com/commerce-cloud-shop-api-connector/latest/shop-api-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 6cbd1fcdeeffae06b1d49480af77130f7a6ce492839140fe22842376bb422b44
description: MuleSoft Documentation Site
release: "2.1"
latest: true
---
---
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).

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#AmOauth2Config_AmOauth2">Shop Account Manager Oauth2 Connection Provider</a></p></div></div></td><td><p>The connection types that can be provided to this configuration.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td><p>MINUTES</p></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td><p>AUTO</p></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The identifier of this element used to reference it in other components</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

### Connection Types

#### Shop Account Manager Oauth2 Connection Provider

##### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for establishing connections to the remote service</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit which qualifies the Connection Timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, each connection will be closed after the first request is completed.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of outbound connections that will be kept open at the same time</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for how long a connection can remain idle before it is closed</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit which qualifies the connection Idle Timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Reusable configuration element for outbound connections through a proxy</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether or not to stream received responses.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The space in bytes for the buffer where the HTTP response will be stored.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Base Uri</p></td><td><div><div><p>String</p></div></div></td><td><p>Each instance, or tenant, gets its own base URI.</p></td><td><p><code>https://{shortCode}.api.commercecloud.salesforce.com</code></p></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#CustomerAuthConfig_ShopperConnection">Shopper Connection Provider</a></p></div></div></td><td><p>The connection types that can be provided to this configuration.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td><p>MINUTES</p></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td><p>AUTO</p></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The identifier of this element used to reference it in other components</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

### Connection Types

#### Shopper Connection Provider

##### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for establishing connections to the remote service</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit which qualifies the Connection Timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, each connection will be closed after the first request is completed.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of outbound connections that will be kept open at the same time</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>A timeout for how long a connection can remain idle before it is closed</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit which qualifies the connection Idle Timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Reusable configuration element for outbound connections through a proxy</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether or not received responses should be streamed</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The space in bytes for the buffer where the HTTP response is stored.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Base Uri</p></td><td><div><div><p>String</p></div></div></td><td><p>Each instance, or tenant, gets its own base URI.</p></td><td><p><code>https://{shortCode}.api.commercecloud.salesforce.com</code></p></td><td></td></tr><tr><td><p>Authorization</p></td><td><div><div><p>String</p></div></div></td><td><p>Shopper JWT token</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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</p></td><td></td><td></td></tr></tbody></table>

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#ShopperTokenConfig_ShopperToken">Shopper Token Connection Provider</a></p></div></div></td><td><p>The connection types that can be provided to this configuration.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td><p>MINUTES</p></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td><p>AUTO</p></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The identifier of this element used to reference it in other components</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

### Connection Types

#### Shopper Token Connection Provider

##### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for establishing connections to the remote service</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit which qualifies the Connection Timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, each connection will be closed after the first request is completed.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of outbound connections that will be kept open at the same time</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>A timeout for how long a connection can remain idle before it is closed</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit which qualifies the connection Idle Timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Reusable configuration element for outbound connections through a proxy</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether or not received responses should be streamed</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The space in bytes for the buffer where the HTTP response will be stored.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Base Uri</p></td><td><div><div><p>String</p></div></div></td><td><p>Each instance, or tenant, gets its own base URI.</p></td><td><p><code>https://{shortCode}.api.commercecloud.salesforce.com</code></p></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

#### Associated Operations

- [Authenticate Customer](#CreateShopperAuthOrganizationsOauth2LoginByVersionOrganizationId)

- [Authorize Customer](#CreateCustomerShopperCustomersOrganizationsCustomersActionsLoginByVersionOrganizationId)

- [Get Access Token](#CreateShopperAuthOrganizationsOauth2TokenByVersionOrganizationId)

## Operations

## Get Reset Password Token

`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-password-actions-create-reset-token-by-version-organization-id>`

Get reset password token. This operation makes an HTTP POST request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/create-reset-token
endpoint..

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-password-actions-reset-by-version-organization-id>`

Reset customer password. This operation makes an HTTP POST request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/password/actions/reset
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-trusted-system-actions-login-by-version-organization-id>`

Obtain the JSON Web Token (JWT) for registered customers whose credentials are stored using a third
party system. Accepts loginId and clientId, returns a customer object in the response body and the
JWT generated against the clientId in the response header. This operation makes an HTTP POST request
to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/trusted-system/actions/login
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-price-books-by-version-organization-id-basket-id>`

Gets applicable price books for an existing basket. This operation makes an HTTP GET request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/price-books
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-taxes-by-version-organization-id-basket-id>`

This method gives you the external taxation data set by the PUT taxes API. This endpoint. can be
called only if external taxation mode was used for basket creation. See POST /baskets for more
information. This operation makes an HTTP GET request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/taxes
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-checkout-shopper-orders-organizations-orders-taxes-by-version-organization-id-order-no>`

This method gives you the external taxation data of the order transferred from the basket during
order creation. This endpoint. can be called only if external taxation was used. See POST /baskets
for more information. This operation makes an HTTP GET request to the
/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/taxes endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Order No</p></td><td><div><div><p>String</p></div></div></td><td><p>The order number of the order to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-items-taxes-by-version-organization-id-basket-id-item-id>`

This method allows you to apply external taxation data to an existing basket to be able to pass tax
rates and optional values for a specific taxable line item. This endpoint. can be called only if
external taxation mode was used for basket creation. See POST /baskets for more information. This
operation makes an HTTP PUT request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId}/taxes
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the item to be updated.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-price-books-by-version-organization-id-basket-id>`

This method allows you to put an array of priceBookIds to an existing basket, which will be used for
basket calculation. This operation makes an HTTP PUT request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/price-books
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-taxes-by-version-organization-id-basket-id>`

This method allows you to apply external taxation data to an existing basket to be able to pass tax
rates and optional values for all taxable line items. This endpoint. can be called only if external
taxation mode was used for basket creation. See POST /baskets for more information. This operation
makes an HTTP PUT request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/taxes
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-by-version-organization-id>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Tax Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INTERNAL</p></li><li><p>EXTERNAL</p></li></ul></div></div></td><td><p>Tax Mode</p></td><td><p>INTERNAL</p></td><td></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-coupons-by-version-organization-id-basket-id>`

Adds a coupon to an existing basket. This operation makes an HTTP POST request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/coupons
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-gift-certificate-items-by-version-organization-id-basket-id>`

Adds a gift certificate item to an existing basket. This operation makes an HTTP POST request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-items-by-version-organization-id-basket-id>`

Adds new items to a basket. The added items are associated with the specified shipment. If no
shipment id is specified, the added items are associated with the default shipment. Considered
values from the request body, for each item are: - productId: a valid product ID. This is the ID of
the product to be added to the basket. If the product is already in the basket, the API either
increments the quantity of the existing product line item or creates a new product line item, based
on the site preference 'Add Product Behavior'. For option products and product bundles containing
base products, the API creates a new product line item regardless of the site preference. -
shipmentId: a valid shipment ID (optional). This is the ID of the shipment in which the product item
is created. - quantity: a number between 0.01 and 999. This is the quantity of the product to
order. - inventoryId: a valid inventory ID (optional). This is the ID of the inventory from which
the item is allocated. - bonusDiscountLineItemId: a valid bonus discount line item ID (optional).
This is the ID of the bonus discount line item for which the added product is a selected bonus
product. - optionItems/optionValueId: a valid option value ID. This is an option value for an option
item of an option product. This is only possible if the product item is an option product. To set
option values, you must specify a collection of option items in the optionItems property. These
option items must contain optionId and optionValueId. Also, the values you specify must be valid for
the option product that this product item represents. Otherwise, the server throws an
InvalidProductOptionItemException or an InvalidProductOptionValueItemException. - custom properties
in the form c\_<CUSTOM\_NAME>: the custom property must correspond to a custom attribute
(<CUSTOM\_NAME>) defined for ProductLineItem. The value of this property must be valid for the type
of custom attribute defined for ProductLineItem. This operation makes an HTTP POST request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-payment-instruments-by-version-organization-id-basket-id>`

Adds a payment instrument to a basket. This operation makes an HTTP POST request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-instruments
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-checkout-shopper-baskets-organizations-baskets-shipments-by-version-organization-id-basket-id>`

Creates a new shipment for a basket. The created shipment is initialized with values provided in the
body document and can be updated with further data API calls. Considered from the body are the
following properties if specified: - the ID - the shipping address - the shipping method - gift
boolean flag - gift message - custom properties This operation makes an HTTP POST request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-checkout-shopper-orders-organizations-orders-by-version-organization-id>`

Submits an order based on a prepared basket. The only considered value from the request body is
basketId. This operation makes an HTTP POST request to the
/checkout/shopper-orders/{version}/organizations/{organizationId}/orders endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-checkout-shopper-orders-organizations-orders-payment-instruments-by-version-organization-id-order-no>`

Adds a payment instrument to an order. Details: The payment instrument is added with the provided
details. The payment method must be applicable for the order see GET
/baskets/{basketId}/payment-methods, if the payment method is 'CREDIT\_CARD' a paymentCard must be
specified in the request. This operation makes an HTTP POST request to the
/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Order No</p></td><td><div><div><p>String</p></div></div></td><td><p>The order number of the order to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id>`

Creates a new address with the given name for the given customer. This operation makes an HTTP POST
request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-by-version-organization-id>`

Registers a new customer. The mandatory data are the credentials, profile last name, and email. This
requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with
type "guest". This operation makes an HTTP POST request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-payment-instruments-by-version-organization-id-customer-id>`

Adds a payment instrument to the customer information. This operation makes an HTTP POST request to
the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id>`

Creates a customer product list. This operation makes an HTTP POST request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id>`

Adds an item to the customer’s product list. Considered values from the request body are: type: A
valid type, mandatory. This is the type of the item to be added to the customer’s product. list.
priority: This is the priority of the item to be added to the customer’s product list. public: This
is the flag whether the item to be added to the customer’s product list is public. product\_id: A
valid product ID, used for product item type only. This is the ID (SKU) of the product related to
the item to be added to the customer’s product list. It is mandatory for product item type, and it
must be a valid product id, otherwise ProductListProductIdMissingException or
ProductListProductNotFoundException will be thrown. quantity: Used for product item type only. This
is the quantity of the item to be added to the customer’s product list. custom properties in the
form c\_<CUSTOM\_NAME>: The custom property must correspond to a custom attribute (<CUSTOM\_NAME>)
defined for ProductListItem. The value of this property must be valid for the type of custom
attribute defined for ProductListItem. This operation makes an HTTP POST request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The product list ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-pricing-shopper-gift-certificates-organizations-gift-certificate-by-version-organization-id>`

Action to retrieve an existing gift certificate. This operation makes an HTTP POST request to the
/pricing/shopper-gift-certificates/{version}/organizations/{organizationId}/gift-certificate
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>`

Removes a basket. This operation makes an HTTP DELETE request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-coupons-by-version-organization-id-basket-id-coupon-item-id>`

Removes a coupon from the basket. This operation makes an HTTP DELETE request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/coupons/{couponItemId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Coupon Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the coupon item to be removed.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-gift-certificate-items-by-version-organization-id-basket-id-gift-certificate-item-id>`

Deletes a gift certificate item from an existing basket. This operation makes an HTTP DELETE request
to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Gift Certificate Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>the ID of the gift certificate item to be updated.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-items-by-version-organization-id-basket-id-item-id>`

Removes a product item from the basket. This operation makes an HTTP DELETE request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the item to be updated.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-payment-instruments-by-version-organization-id-basket-id-payment-instrument-id>`

Removes a payment instrument of a basket. This operation makes an HTTP DELETE request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-instruments/{paymentInstrumentId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Payment Instrument Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Payment Instrument Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-checkout-shopper-baskets-organizations-baskets-shipments-by-version-organization-id-basket-id-shipment-id>`

Removes a specified shipment and all associated product, gift certificate, shipping, and price
adjustment line items from a basket. It is not allowed to remove the default shipment. This
operation makes an HTTP DELETE request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Shipment Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the shipment to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-checkout-shopper-orders-organizations-orders-payment-instruments-by-version-organization-id-order-no-payment-instrument-id>`

Removes a payment instrument of an order. This operation makes an HTTP DELETE request to the
/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Order No</p></td><td><div><div><p>String</p></div></div></td><td><p>The order number of the order to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Payment Instrument Id</p></td><td><div><div><p>String</p></div></div></td><td><p>the ID of the payment instrument to be updated.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-actions-logout-by-version-organization-id>`

Invalidates the JSON Web Token (JWT) provided in the header. This operation makes an HTTP DELETE
request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/actions/logout
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id-address-name>`

Deletes a customer''s address by address name. This operation makes an HTTP DELETE request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Address Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the address to update.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-payment-instruments-by-version-organization-id-customer-id-payment-instrument-id>`

Deletes a customer''s payment instrument. This operation makes an HTTP DELETE request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Payment Instrument Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the payment instrument to be retrievedCustomer.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id-list-id>`

Deletes a customer product list. This operation makes an HTTP DELETE request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The product list ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:delete-customer-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id-item-id>`

Removes an item from a customer product list. This operation makes an HTTP DELETE request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The product list ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the product list item to update.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>`

Gets a basket. This operation makes an HTTP GET request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-payment-methods-by-version-organization-id-basket-id>`

Gets applicable payment methods for an existing basket considering the open payment amount only.
This operation makes an HTTP GET request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/payment-methods
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-checkout-shopper-baskets-organizations-baskets-shipments-shipping-methods-by-version-organization-id-basket-id-shipment-id>`

Gets the applicable shipping methods for a certain shipment of a basket. This operation makes an
HTTP GET request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-methods
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Shipment Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the shipment to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-checkout-shopper-orders-organizations-orders-by-version-organization-id-order-no>`

Gets information for an order. This operation makes an HTTP GET request to the
/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Order No</p></td><td><div><div><p>String</p></div></div></td><td><p>The order number of the order to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-checkout-shopper-orders-organizations-orders-payment-methods-by-version-organization-id-order-no>`

Gets the applicable payment methods for an existing order considering the open payment amount only.
This operation makes an HTTP GET request to the
/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-methods
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Order No</p></td><td><div><div><p>String</p></div></div></td><td><p>The order number of the order to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id-address-name>`

Retrieves a customer''s address by address name. This operation makes an HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Address Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the address to update.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-baskets-by-version-organization-id-customer-id>`

Gets the baskets of a customer. This operation makes an HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/baskets
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-by-version-organization-id-customer-id>`

Gets a customer with all existing addresses and payment instruments associated with the requested
customer. This operation makes an HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-orders-by-version-organization-id-customer-id>`

Returns a pageable list of all customer''s orders. The default page size is 10. This operation makes
an HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/orders
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Cross Sites</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Cross Sites</p></td><td><p>false</p></td><td></td></tr><tr><td><p>from</p></td><td><div><div><p>String</p></div></div></td><td><p>from</p></td><td></td><td></td></tr><tr><td><p>until</p></td><td><div><div><p>String</p></div></div></td><td><p>until</p></td><td></td><td></td></tr><tr><td><p>status</p></td><td><div><div><p>String</p></div></div></td><td><p>status</p></td><td></td><td></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>offset</p></td><td><p>0</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum records to retrieve per request, not to exceed 50. Defaults to 10.</p></td><td><p>10</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-payment-instruments-by-version-organization-id-customer-id-payment-instrument-id>`

Retrieves a customer''s payment instrument by its ID. This operation makes an HTTP GET request to
the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Payment Instrument Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the payment instrument to be retrievedCustomer.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id>`

Returns all customer product lists. This operation makes an HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id-list-id>`

Returns a customer product list of the given customer and the items in the list. This operation
makes an HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The product list ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id-item-id>`

Returns an item of a customer product list and the actual product details like image, availability
and price. This operation makes an HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The product list ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the product list item to update.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-product-lists-by-version-organization-id>`

Retrieves all public product lists as defined by the given search term (for example, email OR first
name and last name). This operation makes an HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/product-lists endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>email</p></td><td><div><div><p>String</p></div></div></td><td><p>The email address of the customer the product lists belong to.</p></td><td></td><td></td></tr><tr><td><p>First Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The first name of the customer the product lists belong to.</p></td><td></td><td></td></tr><tr><td><p>Last Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The last name of the customer the product lists belong to.</p></td><td></td><td></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-product-lists-by-version-organization-id-list-id>`

Retrieves a public product list by ID and the items under that product list. This operation makes an
HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/product-lists/{listId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the list.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-customer-shopper-customers-organizations-product-lists-items-by-version-organization-id-list-id-item-id>`

Retrieves an item from a public product list and the actual product details like product, image,
availability and price. This operation makes an HTTP GET request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/product-lists/{listId}/items/{itemId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the list.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the item.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-pricing-shopper-promotions-organizations-promotions-by-version-organization-id>`

Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can
specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator
characters, you must URL encode these characters. Each request returns only enabled promotions as
the server does not consider promotion qualifiers or schedules. This operation makes an HTTP GET
request to the /pricing/shopper-promotions/{version}/organizations/{organizationId}/promotions
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>ids</p></td><td><div><div><p>String</p></div></div></td><td><p>ids</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>locale</p></td><td><div><div><p>String</p></div></div></td><td><p>locale</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-pricing-shopper-promotions-organizations-promotions-campaigns-by-version-organization-id-campaign-id>`

Handles get promotion by filter criteria. Returns an array of enabled promotions matching the
specified filter criteria. In the request URL, you must provide a campaign\_id parameter, and you
can optionally specify a date range by providing start\_date and end\_date parameters. Both
parameters are required to specify a date range, as omitting one causes the server to return a
MissingParameterException fault. Each request returns only enabled promotions, since the server does
not consider promotion qualifiers or schedules. This operation makes an HTTP GET request to the
/pricing/shopper-promotions/{version}/organizations/{organizationId}/promotions/campaigns/{campaignId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Campaign Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Find the promotions assigned to this campaign (mandatory).</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Start Date</p></td><td><div><div><p>String</p></div></div></td><td><p>The start date of the promotion in ISO8601 date time format: yyyy-MM-dd''T''HH:mmZ</p></td><td></td><td></td></tr><tr><td><p>End Date</p></td><td><div><div><p>String</p></div></div></td><td><p>The end date of the promotion in ISO8601 date time format: yyyy-MM-dd''T''HH:mmZ</p></td><td></td><td></td></tr><tr><td><p>currency</p></td><td><div><div><p>String</p></div></div></td><td><p>The currency mnemonic specified for price. This parameter is effective only for product suggestions.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-product-shopper-products-organizations-categories-by-version-organization-id>`

When you use the URL template, the server returns multiple categories (a result object of category
documents). You can use this template as a convenient way of obtaining multiple categories in a
single request, instead of issuing separate requests for each category. You can specify up to 50
multiple IDs. You must enclose the list of IDs in parentheses. If a category identifier contains
parenthesis or the separator sign, you must URL encode the character. The server only returns online
categories. This operation makes an HTTP GET request to the
/product/shopper-products/{version}/organizations/{organizationId}/categories endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>ids</p></td><td><div><div><p>String</p></div></div></td><td><p>The comma separated list of category IDs (max 50).</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>levels</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>j_0</p></li><li><p>j_1</p></li><li><p>j_2</p></li></ul></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>locale</p></td><td><div><div><p>String</p></div></div></td><td><p>The locale context.</p></td><td></td><td></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-product-shopper-products-organizations-categories-by-version-organization-id-id>`

When you use the URL template below, the server returns a category identified by its ID; by default,
the server also returns the first level of subcategories, but you can specify another level by
setting the levels parameter. The server only returns online categories. This operation makes an
HTTP GET request to the
/product/shopper-products/{version}/organizations/{organizationId}/categories/{id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the requested category.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>levels</p></td><td><div><div><p>Number</p></div></div></td><td><p>levels</p></td><td></td><td></td></tr><tr><td><p>locale</p></td><td><div><div><p>String</p></div></div></td><td><p>locale</p></td><td></td><td></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-product-shopper-products-organizations-products-by-version-organization-id>`

Allows access to multiple products by a single request. Only products that are online and assigned
to a site catalog are returned. The maximum number of productIDs that can be requested are 24.
Alongwith product details, the availability, images, price, promotion and variations data for the
valid products will be included as appropriate. This operation makes an HTTP GET request to the
/product/shopper-products/{version}/organizations/{organizationId}/products endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>ids</p></td><td><div><div><p>String</p></div></div></td><td><p>The IDs of the requested products (comma-separated, max 24 IDs).</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Inventory Ids</p></td><td><div><div><p>String</p></div></div></td><td><p>The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).</p></td><td></td><td></td></tr><tr><td><p>currency</p></td><td><div><div><p>String</p></div></div></td><td><p>The currency mnemonic specified for price.</p></td><td></td><td></td></tr><tr><td><p>locale</p></td><td><div><div><p>String</p></div></div></td><td><p>The locale context.</p></td><td></td><td></td></tr><tr><td><p>All Images</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>The flag that indicates whether to retrieve the whole image model for the requested product.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-product-shopper-products-organizations-products-by-version-organization-id-id>`

Allows access to product details for a single product ID. Only products that are online and assigned
to a site catalog are returned. Along with product details, the
availability,images,price,bundled\_products,set\_products,recommedations,productoptions,variation
and promotion data for the products will be included as appropriate. This operation makes an HTTP
GET request to the /product/shopper-products/{version}/organizations/{organizationId}/products/{id}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the requested product.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Inventory Ids</p></td><td><div><div><p>String</p></div></div></td><td><p>The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).</p></td><td></td><td></td></tr><tr><td><p>currency</p></td><td><div><div><p>String</p></div></div></td><td><p>The currency mnemonic specified for price.</p></td><td></td><td></td></tr><tr><td><p>locale</p></td><td><div><div><p>String</p></div></div></td><td><p>The locale context.</p></td><td></td><td></td></tr><tr><td><p>All Images</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>The flag that indicates whether to retrieve the whole image model for the requested product.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-search-shopper-search-organizations-product-search-by-version-organization-id>`

Provides keyword and refinement search functionality for products. Only returns the product ID,
link, and name in the product search hit. The search result contains only products that are online
and assigned to site catalog. This operation makes an HTTP GET request to the
/search/shopper-search/{version}//organizations/{organizationId}/product-search endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>q</p></td><td><div><div><p>String</p></div></div></td><td><p>The query phrase to search for. For example to search for a product "shirt", type q=shirt.</p></td><td></td><td></td></tr><tr><td><p>refine</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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)&amp;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.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the sorting option to sort the search hits.</p></td><td></td><td></td></tr><tr><td><p>currency</p></td><td><div><div><p>String</p></div></div></td><td><p>The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.</p></td><td></td><td></td></tr><tr><td><p>locale</p></td><td><div><div><p>String</p></div></div></td><td><p>locale</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>offset</p></td><td><p>0</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum records to retrieve per request, not to exceed 200. Defaults to 25.</p></td><td><p>25</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-search-shopper-search-organizations-search-suggestions-by-version-organization-id>`

Provides keyword search functionality for products, categories, and brands suggestions. Returns
suggested products, suggested categories, and suggested brands for the given search phrase. This
operation makes an HTTP GET request to the
/search/shopper-search/{version}//organizations/{organizationId}/search-suggestions endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>q</p></td><td><div><div><p>String</p></div></div></td><td><p>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.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>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).</p></td><td><p>5</p></td><td></td></tr><tr><td><p>currency</p></td><td><div><div><p>String</p></div></div></td><td><p>The currency code specified for price. This parameter is effective only for product suggestions.</p></td><td></td><td></td></tr><tr><td><p>locale</p></td><td><div><div><p>String</p></div></div></td><td><p>locale</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:get-shopper-auth-organizations-oauth2-logout-by-version-organization-id>`

Logs out a shopper. This operation makes an HTTP GET request to the
/shopper/auth/{version}/organizations/{organizationId}/oauth2/logout endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>Version.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Client id</p></td><td><div><div><p>String</p></div></div></td><td><p>SLAS client ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Refresh token</p></td><td><div><div><p>String</p></div></div></td><td><p>Refresh token given during the access token request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel id</p></td><td><div><div><p>String</p></div></div></td><td><p>This field is required if the shopper authenticates using the <code>login</code> endpoint with ECOM.</p></td><td></td><td></td></tr><tr><td><p>hint</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional field for logging out user sessions. Use <code>all-sessions</code> to log out all user sessions. If this field is not used, only the current user session is logged out.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td><p><code>#[null]</code></p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div></li><li><p><code>ALWAYS</code></p><div><p>Connector always streams the request content.</p></div></li><li><p><code>NEVER</code></p><div><p>Connector does not stream the request content.</p></div></li></ul></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-by-version-organization-id-basket-id>`

Updates a basket. Only the currency of the basket, source code, the custom properties of the basket,
and the shipping items will be considered. This operation makes an HTTP PATCH request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-gift-certificate-items-by-version-organization-id-basket-id-gift-certificate-item-id>`

Updates a gift certificate item of an existing basket. This operation makes an HTTP PATCH request to
the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Gift Certificate Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>the ID of the gift certificate item to be updated.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-items-by-version-organization-id-basket-id-item-id>`

Updates an item in a basket. The following values in the request body are considered by the
server: - productId: a valid product ID. The purpose of this value is to exchange a variation of a
variation product. - shipmentId: a valid shipment ID. The purpose of this value is to move a product
item to another shipment. - quantity: a number between 0 and 999. The purpose of this value is to
change quantity of the product item. If quantity is 0, the product item is removed. -
optionItems/optionValueId: a valid option value ID. The purpose of this value is to exchange an
option value for an option item of an option product. This is only possible if the product item is
an option product. To change option values a collection of option items to be changed need to be
provided in property optionItems. Those optionItems need to contain optionId and optionValueId. The
provided values must be valid for the option product that this product item represents. Otherwise
InvalidProductOptionItemException or InvalidProductOptionValueItemException will be thrown. custom
properties c\_<CUSTOM\_NAME>: a value corresponding to the type defined for custom attribute
<CUSTOM\_NAME> of ProductLineItem. The purpose of this value is to add or change the value of a
custom attribute defined for ProductLineItem. This operation makes an HTTP PATCH request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/items/{itemId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the item to be updated.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:patch-checkout-shopper-baskets-organizations-baskets-shipments-by-version-organization-id-basket-id-shipment-id>`

Updates a shipment for a basket. The shipment is initialized with values provided in the body
document and can be updated with further data API calls. Considered from the body are the following
properties if specified: - the ID - the shipping address - the shipping method - gift boolean flag -
gift message - custom properties This operation makes an HTTP PATCH request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Shipment Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the shipment to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:patch-checkout-shopper-orders-organizations-orders-payment-instruments-by-version-organization-id-order-no-payment-instrument-id>`

Updates a payment instrument of an order. Details: The payment instrument is updated with the
provided details. The payment method must be applicable for the order see GET
/baskets/{basketId}/payment-methods, if the payment method is 'CREDIT\_CARD' a paymentCard must be
specified in the request. This operation makes an HTTP PATCH request to the
/checkout/shopper-orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Order No</p></td><td><div><div><p>String</p></div></div></td><td><p>The order number of the order to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Payment Instrument Id</p></td><td><div><div><p>String</p></div></div></td><td><p>the ID of the payment instrument to be updated.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-addresses-by-version-organization-id-customer-id-address-name>`

Updates a customer''s address by address name. This operation makes an HTTP PATCH request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/addresses/{addressName}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Address Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the address to update.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-by-version-organization-id-customer-id>`

Updates a customer. This operation makes an HTTP PATCH request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-product-lists-by-version-organization-id-customer-id-list-id>`

Changes a product list. Changeable properties are the name, description, and if the list is public.
This operation makes an HTTP PATCH request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The product list ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:patch-customer-shopper-customers-organizations-customers-product-lists-items-by-version-organization-id-customer-id-list-id-item-id>`

Updates an item of a customer’s product list. Considered values from the request body are: priority:
This is the priority of the customer’s product list item. public: This is the flag whether the
customer’s product list item is public. quantity: This is the quantity of the customer’s product
list item. Used for product item type only. custom properties in the form c\_<CUSTOM\_NAME>: The
custom property must correspond to a custom attribute (<CUSTOM\_NAME>) defined for ProductListItem.
The value of this property must be valid for the type of custom attribute defined for
ProductListItem. This operation makes an HTTP PATCH request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>List Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The product list ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Item Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the product list item to update.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-billing-address-by-version-organization-id-basket-id>`

Sets the billing address of a basket. This operation makes an HTTP PUT request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/billing-address
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Use As Shipping</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Use As Shipping</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-customer-by-version-organization-id-basket-id>`

Sets customer information for an existing basket. This operation makes an HTTP PUT request to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/customer
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-shipments-shipping-address-by-version-organization-id-basket-id-shipment-id>`

Sets a shipping address of a specific shipment of a basket. This operation makes an HTTP PUT request
to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-address
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Shipment Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the shipment to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Use As Billing</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Use As Billing</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:update-checkout-shopper-baskets-organizations-baskets-shipments-shipping-method-by-version-organization-id-basket-id-shipment-id>`

Sets a shipping method to a specific shipment of a basket. This operation makes an HTTP PUT request
to the
/checkout/shopper-baskets/{version}/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-method
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Basket Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the basket to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Shipment Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the shipment to be modified.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:update-customer-shopper-customers-organizations-customers-password-by-version-organization-id-customer-id>`

Updates the customer''s password. This operation makes an HTTP PUT request to the
/customer/shopper-customers/{version}/organizations/{organizationId}/customers/{customerId}/password
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Customer Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer ID.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-customer-shopper-customers-organizations-customers-actions-login-by-version-organization-id>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>version</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Client Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Client ID for application identification</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Site Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Site Id</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Authorization</p></td><td><div><div><p>String</p></div></div></td><td><p>Authorization:Basic for type credentials Authorization:Bearer for type refresh</p></td><td></td><td></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to be used to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the Response Timeout.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-shopper-auth-organizations-oauth2-login-by-version-organization-id>`

Authenticates an ECOM customer. This operation makes an HTTP POST request to the
/shopper/auth/{version}/organizations/{organizationId}/oauth2/login endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>Version.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Login</p></td><td><div><div><p>String</p></div></div></td><td><p>Base64-encoded username and password for HTTP Basic authentication.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Content to use.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div></li><li><p><code>ALWAYS</code></p><div><p>Connector always streams the request content.</p></div></li><li><p><code>NEVER</code></p><div><p>Connector does not stream the request content.</p></div></li></ul></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

`<commerce-cloud-shopper-api:create-shopper-auth-organizations-oauth2-token-by-version-organization-id>`

Gets a JWT access token and a refresh token for the shopper or guest. This is the second step of the
OAuth 2.0 authorization code flow. The client appplication gets an access token through the back
channel (a trusted server) by passing in the client credentials and the authorization code retrieved
from the `authorize` endpoint.

When refreshing the access token with a private client ID, the refresh token is not regenerated.
However, when refreshing the access token with a public client ID, the refresh token is regenerated.
The old refresh token is voided with every refresh call, so the refresh token must be replaced to
store the new refresh token.

This operation makes an HTTP POST request to the
/shopper/auth/{version}/organizations/{organizationId}/oauth2/token endpoint.

> [!IMPORTANT] Use the `channel_id` query parameter because it will be required in the future.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>Version.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Organization Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization</p></td><td><div><div><p>String</p></div></div></td><td><p>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: <code>clientId:clientSecret</code>. This field is required unless the grant type is <code>authorization_code_pkce</code>.</p></td><td></td><td></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Content to use.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div></li><li><p><code>ALWAYS</code></p><div><p>Connector always streams the request content.</p></div></li><li><p><code>NEVER</code></p><div><p>Connector does not stream the request content.</p></div></li></ul></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Key</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Value</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr></tbody></table>

### Default Query Param

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Key</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Value</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr></tbody></table>

### Proxy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Non Proxy Hosts</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Enabled Protocols</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma separated list of protocols enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Enabled Cipher Suites</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma separated list of cipher suites enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Trust Store</p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Key Store</p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Revocation Check</p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom Ocsp Responder</a></p></li><li><p><a href="#CrlFile">Crl File</a></p></li></ul></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the trust store.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the trust store.</p></td><td></td><td></td></tr><tr><td><p>Insecure</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></td><td></td><td></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Key Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the private key.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the key store.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the key store.</p></td><td></td><td></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Only End Entities</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Only verify the last element of the certificate chain.</p></td><td></td><td></td></tr><tr><td><p>Prefer Crls</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Try CRL instead of OCSP first.</p></td><td></td><td></td></tr><tr><td><p>No Fallback</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Do not use the secondary checking method (the one not selected before).</p></td><td></td><td></td></tr><tr><td><p>Soft Fail</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></td><td></td><td></td></tr></tbody></table>

### Custom Ocsp Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The URL of the OCSP responder.</p></td><td></td><td></td></tr><tr><td><p>Cert Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></td><td></td><td></td></tr></tbody></table>

### Crl File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path to the CRL file.</p></td><td></td><td></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often (in ms) to reconnect</p></td><td></td><td></td></tr><tr><td><p>Blocking</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, the reconnection strategy will run in a separate, non-blocking thread</p></td><td></td><td></td></tr><tr><td><p>Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>How many reconnection attempts to make</p></td><td></td><td></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often (in ms) to reconnect</p></td><td></td><td></td></tr><tr><td><p>Blocking</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, the reconnection strategy will run in a separate, non-blocking thread</p></td><td></td><td></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>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</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute</p></td><td></td><td></td></tr></tbody></table>

### Http Response Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Status Code</p></td><td><div><div><p>Number</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Reason Phrase</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr></tbody></table>

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which all these attributes are expressed</p></td><td></td><td></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>