# mulesoft Salesforce Commerce Cloud B2C Data Connector - Full Documentation

<!-- document id=400f12b92eff3fbb021a055d10c0c369553d94c4690d77e8b6712345b70b13ba url=/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/index.md -->

---
product: Salesforce Commerce Cloud B2C Data Connector
version: 1.0
is-latest-version: true
---

# Salesforce Commerce Cloud B2C Data Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] No further updates or new versions are planned for this connector. Use
> [Anypoint Connector for HTTP (HTTP Connector)](https://docs.mulesoft.com/http-connector/latest/) instead. Refer to the
> [migration guide](https://developer.salesforce.com/docs/commerce/commerce-api/guide/migrate-mulesoft-http-connector.html).

Anypoint Connector for Salesforce Commerce Cloud B2C Data API (B2C Data Connector) enables you to
access the Commerce Cloud Data API by using certain configurations, and to then access the data,
update the data, and delete the data, as required.

> [!NOTE] Salesforce Commerce Cloud B2C Data Connector and Salesforce Commerce Cloud B2C Shop
> Connector cannot be run in the same application.

## Before You Begin

To use this connector, you must be familiar with:

- The Commerce Cloud Data API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- Creating a Mule app using Anypoint Studio or Anypoint Code Builder

Before creating an app, you must have:

- Anypoint Studio version 7 or later

- Commerce Cloud credentials such as client Id, Client Secret, and Scopes to access the Data API.  
  You can get the required credentials from the Salesforce team.

## Audience

- New users, read:

  - [Using Anypoint Studio to Configure B2C Data Connector](https://docs.mulesoft.com/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-studio)
    to create your Mule app.

  - The [Examples](https://docs.mulesoft.com/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-examples) topic, which provides one or more use
    cases for using the connector.

- Advanced users, read:

  - [XML and Maven Support](https://docs.mulesoft.com/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-xml-maven)

  - The [Examples](https://docs.mulesoft.com/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-examples) topic, which provides one or more use
    cases for using the connector.

## Authentication Types

B2C Data Connector connections use the OAuth 2 Application Provider authentication type.

## Next Step

After you complete the prerequisites, you are ready to create your own app and configure the
connector using [Anypoint Studio](https://docs.mulesoft.com/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-studio).

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=eba3338c94975db70415263de0d069ad9dd1e42cf10dc561c5dc0d7d5f6367cc url=/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-examples.md -->

---
product: Salesforce Commerce Cloud B2C Data Connector
version: 1.0
is-latest-version: true
---

# Salesforce Commerce Cloud B2C Data Connector Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This example shows how to execute a search for assignments and get the search results.

This image shows the assignment search example flow:

![Search assignment flow with HTTP Listener, Assignment Search operation, and Error handling](/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/_images/data-connector-assignments-search-flow.jpg)

## Configure the HTTP Listener Source

In Studio, create a new Mule project in which to add and configure the source for the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

3.  In the **Mule Palette** view, select **HTTP > Listener**.

4.  Drag **Listener** to the Studio canvas.

5.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

6.  Specify `/assignmentsSearch` for the **Path** field.

    ![HTTP Listener General configuration example values](/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/_images/data-connector-http-listener-config.jpg)

7.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the HTTP listener in the app.

    1.  On the **General** tab, enter `8081` in **Port**.

    2.  Click **Test Connection**.

    3.  Click **OK**.

8.  Save the Mule project. .

## Configure the Assignments Search Operation

1.  From the **Mule Palette** view, select the **Assignment Search** operation from the palette and
    drag it on to the flow.

2.  Navigate to `http://localhost:8081/assignmentsSearch`, open Postman, and copy the required body
    for the **Assignments Search** operation:

    ![Assignments Search operation example Content body](/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/_images/data-connector-assignment-search-body.jpg)

    A sample **Assignments Search** operation payload is shown here:

```json
{
  "count": 4,
  "query": {
    "textQuery": {
      "fields": ["description"],
      "searchPhrase": "*"
    }
  },
  "start": 2
}
```

1.  Add the body you obtained in the previous step to the **Content** parameter.

2.  Click the plus sign (**+**) next to the **Connector configuration** field to configure B2C Data
    Connector with the required values:

    ![OAuth 2 Application Connection Provider authentication configuration example](/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/_images/data-api-connector-oauth2-configuration.jpg)

3.  Click **Test Connection**.

4.  Save the Mule project.

## Run the Mule Application

Run the project as a Mule application:

1.  In **Package Explorer**, right-click the project name and select **Run As > Mule Application**.

2.  Navigate to `http://localhost:8081/assignmentsSearch`, open Postman, and check the response.

You see the search data result in the output.

### XML Example

Paste this code into the **Configuration XML** tab in Studio to quickly load the flow for this
example into your Mule app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:commerce-cloud-dataapi="http://www.mulesoft.org/schema/mule/commerce-cloud-dataapi" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/commerce-cloud-dataapi http://www.mulesoft.org/schema/mule/commerce-cloud-dataapi/current/mule-commerce-cloud-dataapi.xsd">
	<flow name="assignments-searchFlow" >
		<http:listener doc:name="8081/pricing/assignments/{version}/organizations/{organizationId}/assignments"  config-ref="HTTP_Listener_config" path="/pricing/assignments/{version}/organizations/{organizationId}/assignments"/>
		<commerce-cloud-dataapi:create-pricing-assignments-organizations-assignments-by-version-organization-id doc:name="Assignments Search"
    config-ref="Commerce_Cloud_Data_Connector_Config" version="#[attributes.uriParams.version]" organizationId="#[attributes.uriParams.organizationId]" siteId="#[attributes.queryParams.siteId]">
			<commerce-cloud-dataapi:content ><![CDATA[#[{
  "count": 4,
  "query": {
    "textQuery": {
      "fields": [
        "description"
      ],
      "searchPhrase": "*"
    }
  },
  "start": 2
}]]]></commerce-cloud-dataapi:content>
		</commerce-cloud-dataapi:create-pricing-assignments-organizations-assignments-by-version-organization-id>
	</flow>
</mule>
```

After adding the code in the Configuration XML tab, you can see the flow in the \*Message Flow\* tab
of the canvas.

## See Also

- [Salesforce Help](https://help.salesforce.com)

- [B2C Data Connector Reference](https://docs.mulesoft.com/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-reference)

<!-- document id=b9c48fdb0b2f72028d4ef27141627e6a84a13b426ef6d871d84438eafd84450d url=/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-reference.md -->

---
product: Salesforce Commerce Cloud B2C Data Connector
version: 1.0
is-latest-version: true
---

# Salesforce Commerce Cloud B2C Data Connector 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 Data (B2C Data Connector) is an operation-based
connector, which means that when you add the connector to your flow, you need to configure a
specific operation for the connector to perform.

B2C Data Connector supports OAuth 2 authentication configuration for connections.

## Limitations

- Salesforce Commerce Cloud B2C Data Connector and Salesforce Commerce Cloud B2C Shop Connector
  cannot be run in the same application.

## OAuth2 Configuration

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

### 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>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><ul><li><p><a href="#DataConfiguration_Oauth2Application">Oauth2 Application Connection Provider</a></p></li></ul></div></div></td><td><p>The connection types to provide 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>Timeout for the 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>Time unit that qualifies the Response Timeout.</p></td><td><p>MINUTES</p></td><td></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>

### Oauth2 Application 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>Time unit that 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 <code>false</code>, each connection is 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 to keep open concurrently.</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 that 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 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>Parameter base URI. Each instance or tenant gets its own base URI.</p></td><td><p>default base URI</p></td><td></td></tr><tr><td><p>Protocol</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><p>Protocol to use for communication. Valid values are HTTP and HTTPS.</p></td><td><p>HTTP</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 <code>true</code>, the deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr><tr><td><p>Client Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth client ID as registered with the service provider. Contact Salesforce for this information.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>Client Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth client secret as registered with the service provider. Contact Salesforce for this information.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s token endpoint URL.</p></td><td><p>default token URL</p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth scopes to request during the OAuth dance.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store.</p></td><td></td><td></td></tr></tbody></table>

## Operations

- [Assign Product To Category](#AssignProductToCategory)

- [Assign Variation For Master Product](#AssignVariationForMasterProduct)

- [Assign Variation Group To Master Product](#AssignVariationGroupToMasterProduct)

- [Assignments Search](#AssignmentsSearch)

- [Campaigns Search](#CampaignsSearch)

- [Coupon Redemptions Search](#CouponRedemptionsSearch)

- [Coupons Search](#CouponsSearch)

- [Create Address For Customer In Customer List](#CreateAddressForCustomerInCustomerList)

- [Create Campaign](#CreateCampaign)

- [Create Category In Catalog](#CreateCategoryInCatalog)

- [Create Coupon](#CreateCoupon)

- [Create Customer In Customer List](#CreateCustomerInCustomerList)

- [Create Customer List](#CreateCustomerList)

- [Create Gift Certificate](#CreateGiftCertificate)

- [Create Product](#CreateProduct)

- [Create Product Option](#CreateProductOption)

- [Create Product Option Value](#CreateProductOptionValue)

- [Create promotion](#CreatePromotion)

- [Create Source Code Group](#CreateSourceCodeGroup)

- [Create Variation Attribute](#CreateVariationAttribute)

- [Create Variation Attribute Value](#CreateVariationAttributeValue)

- [Delete Campaign](#DeleteCampaign)

- [Delete Category From Catalog](#DeleteCategoryFromCatalog)

- [Delete Coupon](#DeleteCoupon)

- [Delete Customer From Customer List](#DeleteCustomerFromCustomerList)

- [Delete Gift Certificate](#DeleteGiftCertificate)

- [Delete Product](#DeleteProduct)

- [Delete Product Option](#DeleteProductOption)

- [Delete Product Option Value](#DeleteProductOptionValue)

- [Delete Promotion](#DeletePromotion)

- [Delete Source Code Group](#DeleteSourceCodeGroup)

- [Delete Variation Attribute](#DeleteVariationAttribute)

- [Delete Variation Attribute Value](#DeleteVariationAttributeValue)

- [Get Address For Customer From Customer List](#GetAddressForCustomerFromCustomerList)

- [Get Addresses For Customer From Customer List](#GetAddressesForCustomerFromCustomerList)

- [Get Assigned Product From Category](#GetAssignedProductFromCategory)

- [Get Campaign](#GetCampaign)

- [Get Catalog](#GetCatalog)

- [Get Catalogs](#GetCatalogs)

- [Get Categories From Catalog](#GetCategoriesFromCatalog)

- [Get Category From Catalog](#GetCategoryFromCatalog)

- [Get Coupon](#GetCoupon)

- [Get Coupon Codes](#GetCouponCodes)

- [Get Customer From Customer List](#GetCustomerFromCustomerList)

- [Get Gift Certificate](#GetGiftCertificate)

- [Get Product](#GetProduct)

- [Get Product Option](#GetProductOption)

- [Get Product Option Value](#GetProductOptionValue)

- [Get Product Options](#GetProductOptions)

- [Get Promotion](#GetPromotion)

- [Get Source Code Group](#GetSourceCodeGroup)

- [Get Variation Attribute](#GetVariationAttribute)

- [Get Variation Attribute Value](#GetVariationAttributeValue)

- [Get Variation Attributes](#GetVariationAttributes)

- [Get Variation For Master Product](#GetVariationForMasterProduct)

- [Get Variation Group For Master Product](#GetVariationGroupForMasterProduct)

- [Get Variation Groups For Master Product](#GetVariationGroupsForMasterProduct)

- [Get Variations For Master Product](#GetVariationsForMasterProduct)

- [Get Variations For Master Product](#GiftCertificatesSearch)

- [Promotions Search](#PromotionsSearch)

- [Remove Address For Customer In Customer List](#RemoveAddressForCustomerInCustomerList)

- [Search Catalogs](#SearchCatalogs)

- [Search Categories](#SearchCategories)

- [Search Categories In Catalog](#SearchCategoriesInCatalog)

- [Search Customer In Customer List](#SearchCustomerInCustomerList)

- [Search Product Variations](#SearchProductVariations)

- [Search Products](#SearchProducts)

- [Search Products Assigned To Category](#SearchProductsAssignedToCategory)

- [Source Code Groups Search](#SourceCodeGroupsSearch)

- [Unassign Product From Category](#UnassignProductFromCategory)

- [Unassign Variation From Master Product](#UnassignVariationFromMasterProduct)

- [Unassign Variation Group From Master Product](#UnassignVariationGroupFromMasterProduct)

- [Update Address For Customer In Customer List](#UpdateAddressForCustomerInCustomerList)

- [Update Campaign](#UpdateCampaign)

- [Update Catalog](#UpdateCatalog)

- [Update Category In Catalog](#UpdateCategoryInCatalog)

- [Update Coupon](#UpdateCoupon)

- [Update Coupon Codes](#UpdateCouponCodes)

- [Update Customer In Customer List](#UpdateCustomerInCustomerList)

- [Update Gift Certificate](#UpdateGiftCertificate)

- [Update Order](#UpdateOrder)

- [Update Order Confirmation Status](#UpdateOrderConfirmationStatus)

- [Update Order Export Status](#UpdateOrderExportStatus)

- [Update Order External Status](#UpdateOrderExternalStatus)

- [Update Order Payment Instrument](#UpdateOrderPaymentInstrument)

- [Update Order Payment Status](#UpdateOrderPaymentStatus)

- [Update Order Payment Transaction](#UpdateOrderPaymentTransaction)

- [Update Order Shipping Address](#UpdateOrderShippingAddress)

- [Update Order Shipping Status](#UpdateOrderShippingStatus)

- [Update Order Status](#UpdateOrderStatus)

- [Update Product](#UpdateProduct)

- [Update Product Category Assignment](#UpdateProductCategoryAssignment)

- [Update Product Option](#UpdateProductOption)

- [Update Product Option value](#UpdateProductOptionValue)

- [Update Promotion](#UpdatePromotion)

- [Update Source Code Group](#UpdateSourceCodeGroup)

- [Update Variation Attribute](#UpdateVariationAttribute)

- [Update Variation Attribute Value](#UpdateVariationAttributeValue)

- [Update Variation For Master Product](#UpdateVariationForMasterProduct)

- [Update Variation Group For Master Product](#UpdateVariationGroupForMasterProduct)

- [Unauthorize](#Unauthorize)

## Assign Product To Category

`<commerce-cloud-dataapi:assign-product-to-category>`

Creates a category product assignment using the information provided. This operation makes an HTTP
PUT request to the `/product/catalogs/{version}/organizations/{organizationId}/products/{productId}`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>Timeout for a 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Assign Variation For Master Product

`<commerce-cloud-dataapi:assign-variation-for-master-product>`

Assign a variation for a product master. If the variation product does not initially exist, one is
created using the body that is passed in. This operation makes an HTTP PUT request to the
`/product/catalogs/{version}/organizations/{organizationId}/{masterProductId}/variations` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>Master product ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Assign Variation Group To Master Product

`<commerce-cloud-dataapi:assign-variation-group-to-master-product>`

Assign a variation group for a product master. If the variation group product does not initially
exist, one is created using the body that is passed in. This operation makes an HTTP PUT request to
the `/product/catalogs/{version}/organizations/{organizationId}/{masterProductId}/variation-groups`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>Master product ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Assignments Search

`<commerce-cloud-dataapi:assignment-search>`

Performs a search operation for Assignments. This operation makes an HTTP POST request to the
`/pricing/assignments/{{version}}/organizations/{{organizationId}}/assignments` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component</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>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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Campaigns Search

`<commerce-cloud-dataapi:campaigns-search>`

Searches for campaigns using a search request object that allows filtering on various attributes.
This operation makes an HTTP POST request to the
/pricing/campaigns/{version}/organizations/{organizationId}/campaigns 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Coupon Redemptions Search

`<commerce-cloud-dataapi:coupon-redemptions-search>`

Searches for coupon redemptions. The Coupon Redemption Search document contains a search object that
allows filtering on various attributes. This operation makes an HTTP POST request to the
`/pricing/coupons/{version}/organizations/{organizationId}/coupons/redemptions` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Coupons Search

`<commerce-cloud-dataapi:coupons-search>`

Searches for coupons. This operation makes an HTTP POST request to the
`/pricing/coupons/{version}/organizations/{organizationId}` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Address For Customer In Customer List

`<commerce-cloud-dataapi:create-address-for-customer-in-customer-list>`

Searches for coupons. This operation makes an HTTP POST request to the
`/pricing/coupons/{version}/organizations/{organizationId}` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Campaign

`<commerce-cloud-dataapi:create-campaign>`

Creates a campaign using the information provided. This operation makes an HTTP PUT request to the
/pricing/campaigns/{version}/organizations/{organizationId}/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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>campaignId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the campaign</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout..</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Category In Catalog

`<commerce-cloud-dataapi:create-category-in-catalog>`

Creates a catalog category using the information provided. This operation makes an HTTP PUT request
to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Coupon

`<commerce-cloud-dataapi:create-coupon>`

Creates a coupon using the information provided. If a coupon exists with the same unique identifier,
the coupon is replaced completely. This operation makes an HTTP PUT request to the
`/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>couponId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the coupon to create.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Customer In Customer List

`<commerce-cloud-dataapi:create-customer-in-customer-list>`

Action to create a new customer. The customer is created using the specified customer number,
credentials, and customer information.

This action verifies the following:

- Login acceptance criteria and uniqueness

- Mandatory customer properties

If the action fails to create the customer, it returns a `400` error with an appropriate message.

This operation makes an HTTP PUT request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>listId</p></td><td><div><div><p>String</p></div></div></td><td><p>List ID to which to add the customer.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>customerNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Customer number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Customer List

`<commerce-cloud-dataapi:create-customer-list>`

Action to create a new customer. The customer is created using the specified credentials and
customer information.

This action verifies the following:

- Login acceptance criteria and uniqueness

- Mandatory customer properties

If the action fails to create the customer, it returns a `400` error with an appropriate message.

This operation makes an HTTP PUT request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>listId</p></td><td><div><div><p>String</p></div></div></td><td><p>List ID to which to add the customer.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Gift Certificate

`<commerce-cloud-dataapi:create-gift-certificate>`

Creates a gift certificate using the information provided. If a gift certificate with the same
unique identifier is generated, it is deleted and a new one is created. This operation makes an HTTP
PUT request to the
`/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Product

`<commerce-cloud-dataapi:create-product>`

Creates a product using the information provided. If a product with the same unique identifier
exists, it is overwritten unless the header `x-dw-validate-existing=true` is passed in with the
request.

This operation makes an HTTP PUT request to the
`/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version..</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product 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>Name of the configuration to use to execute this component.</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 the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Product Option

`<commerce-cloud-dataapi:create-product-option>`

Creates a local product option using the information provided or binds a shared product option to
the product.

This operation makes an HTTP PUT request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product 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>ID of the local or shared product option.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Product Option Value

`<commerce-cloud-dataapi:create-product-option-value>`

Creates a local product option value using the information provided. This operation makes an HTTP
PUT request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>optionId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the local product option.</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>ID of the local product option value.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create promotion

`<commerce-cloud-dataapi:create-promotion>`

Creates a promotion using the information provided. This operation makes an HTTP PUT request to the
`/pricing/promotions/{version}/organizations/{organizationId}/promotions/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>ID of the promotion to create.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Source Code Group

`<commerce-cloud-dataapi:create-source-code-group>`

Creates a source code group using the information provided. This operation makes an HTTP PUT request
to the /pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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 source code group to create</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Variation Attribute

`<commerce-cloud-dataapi:create-variation-attribute>`

Creates a variation attribute using the information provided. This operation makes an HTTP PUT
request to the
/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the product</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 variation attribute</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Create Variation Attribute Value

`<commerce-cloud-dataapi:create-variation-attribute-value>`

Action to create a product variation attribute value. This operation makes an HTTP PUT request to
the
`product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the product.</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>ID of the variation attribute value.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>attributeId</p></td><td><div><div><p>String</p></div></div></td><td><p>Variation attribute 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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Campaign

`<commerce-cloud-dataapi:delete-campaign>`

Deletes the campaign by ID. This operation makes an HTTP DELETE request to the
`/pricing/campaigns/{version}/organizations/{organizationId}/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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>campaignId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the campaign.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Category From Catalog

`<commerce-cloud-dataapi:delete-category-from-catalog>`

Deletes the category by catalog ID and category ID. This operation makes an HTTP DELETE request to
the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the category to create.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Coupon

`<commerce-cloud-dataapi:delete-coupon>`

Delete a coupon by ID. This operation makes an HTTP DELETE request to the
`/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}` 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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>couponId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the coupon to delete.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Customer From Customer List

`<commerce-cloud-dataapi:delete-customer-from-customer-list>`

Deletes the customer, including all related information like the customer addresses. This operation
makes an HTTP DELETE request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>listId</p></td><td><div><div><p>String</p></div></div></td><td><p>List ID from which to delete the customer.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>customerNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Customer number.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Gift Certificate

`<commerce-cloud-dataapi:delete-gift-certificate>`

Deletes the gift certificate by merchant ID. This operation makes an HTTP DELETE request to the
`/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates/{merchantId}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>merchantId</p></td><td><div><div><p>String</p></div></div></td><td><p>Merchant ID of the requested gift certificate.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site..</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Product

`<commerce-cloud-dataapi:delete-product>`

Deletes the product by ID. This operation makes an HTTP DELETE request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}` 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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product 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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Product Option

`<commerce-cloud-dataapi:delete-product-option>`

Deletes a local product option or unbinds a shared product option from the product. This operation
makes an HTTP DELETE request to the
/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product 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 local or shared product option</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Product Option Value

`<commerce-cloud-dataapi:delete-product-option-value>`

Deletes a local product option value by ID. This operation makes an HTTP DELETE request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product 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 local product option value</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>optionId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the local product option</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Promotion

`<commerce-cloud-dataapi:delete-promotion>`

Deletes the promotion by ID. This operation makes an HTTP DELETE request to the
`/pricing/promotions/{version}/organizations/{organizationId}/promotions/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>ID of the promotion to delete.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Source Code Group

`<commerce-cloud-dataapi:delete-source-code-group>`

Deletes the source code group by ID. This operation makes an HTTP DELETE request to the
/pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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 source code group to delete</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Variation Attribute

`<commerce-cloud-dataapi:delete-variation-attribute>`

Deletes the variation attribute by ID. This operation makes an HTTP DELETE request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the product</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 variation attribute to delete</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Delete Variation Attribute Value

`<commerce-cloud-dataapi:delete-variation-attribute-value>`

Deletes the variation attribute value of a variation attribute bound to a master product. This
operation makes an HTTP DELETE request to the
/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the product</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>attributeId</p></td><td><div><div><p>String</p></div></div></td><td><p>The variation attribute 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 variation attribute value</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Address For Customer From Customer List

`<commerce-cloud-dataapi:get-address-for-customer-from-customer-list>`

Action that returns a single customer address from a customer list. This operation makes an HTTP GET
request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}/addresses/{addressId}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>customerNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Customer number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>listId</p></td><td><div><div><p>String</p></div></div></td><td><p>List Id for the list from which to return the customer.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter. Maximum number of records to retrieve per request. The minimum value is <code>0</code>.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter. Used to retrieve the results based on a particular resource offset. The maximum value is <code>50</code>.</p></td><td><p>25</p></td><td></td></tr><tr><td><p>addressId</p></td><td><div><div><p>String</p></div></div></td><td><p>The address 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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Addresses For Customer From Customer List

`<commerce-cloud-dataapi:get-addresses-for-customer-from-customer-list>`

Action that returns a pageable list of all customer addresses. The default page size is 10 customer
addresses. This operation makes an HTTP GET request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}/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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>customerNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Customer number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>listId</p></td><td><div><div><p>String</p></div></div></td><td><p>List 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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Assigned Product From Category

`<commerce-cloud-dataapi:get-assigned-product-from-category>`

Retrieves a category product assignment. For example, if there are products A, B, and C at positions
1, 2, and 7.5, and you delete the assignment for product B, the products A, B, and C move up one
position, and position 7.5 is left null. This operation makes an HTTP GET request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the category to be created.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID (SKU) of the requested product to assign.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Campaign

`<commerce-cloud-dataapi:get-campaign>`

Action to get campaign information. This operation makes an HTTP GET request to the
`/pricing/campaigns/{version}/organizations/{organizationId}/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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>campaignId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the campaign.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Catalog

`<commerce-cloud-dataapi:get-catalog>`

Gets the catalog with the specified information. This operation makes an HTTP GET request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}` 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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Catalogs

`<commerce-cloud-dataapi:get-catalogs>`

Action to get the list of catalog IDs with no filtering. This operation makes an HTTP GET request to
the `/product/catalogs/{version}/organizations/{organizationId}/catalogs` 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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter. Maximum records to retrieve per request. The minimum value is 0.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter. Used to retrieve the results based on a particular resource offset. The maximum value is 50.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Categories From Catalog

`<commerce-cloud-dataapi:get-categories-from-catalog>`

Action to get all the categories with no filtering. This operation makes an HTTP GET request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter. Maximum records to retrieve per request. The minimum value is 0.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter. Used to retrieve the results based on a particular resource offset. The maximum value is 50.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Category From Catalog

`<commerce-cloud-dataapi:get-category-from-catalog>`

Action to read an existing category within a catalog.

By default, the server also returns the first level of subcategories, but you can specify another
level by setting the `levels` parameter. Using a large value for the `levels` parameter can cause
performance issues if the category tree is large and deep.

This operation makes an HTTP GET request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the requested catalog</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the category to be created</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>levels</p></td><td><div><div><p>Integer</p></div></div></td><td><p>Level number query parameter. The minimum value is 0.</p></td><td><p>0</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Coupon

`<commerce-cloud-dataapi:get-coupon>`

Returns coupon information for the given coupon ID. If the user role does not have the
`View_Coupon_Codes` permission, then the coupon codes that are returned are masked. This operation
makes an HTTP GET request to the
`/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}` 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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>couponId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the coupon.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Coupon Codes

`<commerce-cloud-dataapi:get-coupon-codes>`

Gets the coupon codes for the given coupon. If the user role does not have the `View_Coupon_Codes`
permission, then the coupon codes returned are masked. This operation makes an HTTP GET request to
the `/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}/codes` 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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>couponId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the coupon.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Integer</p></div></div></td><td><p>Maximum records to retrieve per request query parameter. The minimum value is 0.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.</p></td><td><p>25</p></td><td></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Customer From Customer List

`<commerce-cloud-dataapi:get-customer-from-customer-from-customer-list>`

Action to get customer information. This operation makes an HTTP GET request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>listId</p></td><td><div><div><p>String</p></div></div></td><td><p>The list Id</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>customerNo</p></td><td><div><div><p>String</p></div></div></td><td><p>The customer number</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Gift Certificate

`<commerce-cloud-dataapi:get-gift-certificate>`

Action to get gift certificate information using the merchant ID. This operation makes an HTTP GET
request to the
`/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates/{merchantId}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>merchantId</p></td><td><div><div><p>String</p></div></div></td><td><p>Merchant ID of the requested gift certificate.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Product

`<commerce-cloud-dataapi:get-product>`

Action to get product information. This operation makes an HTTP GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}` 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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Product Option

`<commerce-cloud-dataapi:get-product-option>`

Read a local or shared product option of a product. This operation makes an HTTP GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product 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>ID of the local or shared product option.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>currency</p></td><td><div><div><p>String</p></div></div></td><td><p>Query parameter for currency.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Product Option Value

`<commerce-cloud-dataapi:get-product-option-value>`

Read a local product option value of a local product option in a product. This operation makes an
HTTP GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product 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>ID of the local product option value.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Product Options

`<commerce-cloud-dataapi:get-product-options>`

Read local and shared product options of a product. This operation makes an HTTP GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter for maximum number of records to retrieve per request. The minimum value is 0.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.</p></td><td><p>25</p></td><td></td></tr><tr><td><p>currency</p></td><td><div><div><p>String</p></div></div></td><td><p>The query param for currency</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Promotion

`<commerce-cloud-dataapi:get-promotion>`

Action to get promotion information. This operation makes an HTTP GET request to the
`/pricing/promotions/{version}/organizations/{organizationId}/promotions/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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 promotion to get</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Source Code Group

`<commerce-cloud-dataapi:get-source-code-group>`

Action to retrieve source code group information. This operation makes an HTTP GET request to the
`/pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>ID of the source code group to get.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Variation Attribute

`<commerce-cloud-dataapi:get-variation-attribute>`

Action to get only variation attribute information for master product. This operation makes an HTTP
GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the product</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 variation attribute to get</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Variation Attribute Value

`<commerce-cloud-dataapi:get-variation-attribute-value>`

Action to get product variation attribute value information. This operation makes an HTTP GET
request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the product</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>ID of the variation attribute value.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>attributeId</p></td><td><div><div><p>String</p></div></div></td><td><p>Variation attribute ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Variation Attributes

`<commerce-cloud-dataapi:get-variation-attributes>`

Reads variation attributes of a product of type variant, variation master, or variation group. This
operation makes an HTTP GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the product</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter for the maximum number of records to retrieve per request. The minimum value is 0.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Integer</p></div></div></td><td><p>The query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Variation For Master Product

`<commerce-cloud-dataapi:get-variation-for-master-product>`

Read a variation for a product master. This operation makes an HTTP GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variations/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the master product that contains the variation group.</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>ID of the variation product.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Variation Group For Master Product

`<commerce-cloud-dataapi:get-variation-group-for-master-product>`

Read a variation group for a product master. This operation makes an HTTP GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variation-groups/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the master product that contains the variation group.</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>ID of the variation group product.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Variation Groups For Master Product

`<commerce-cloud-dataapi:get-variation-groups-for-master-product>`

Reads variation groups for a product master. This operation makes an HTTP GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variation-groups`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the master product that contains the variation group.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Integer</p></div></div></td><td><p>Query parameter for the maximum number of records to retrieve per request. The minimum value is 0.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Integer</p></div></div></td><td><p>Query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.</p></td><td><p>25</p></td><td></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Variations For Master Product

`<commerce-cloud-dataapi:get-variations-for-master-product>`

Reads variation for a product master. This operation makes an HTTP GET request to the
`/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variations`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the master product that contains the variation group.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Integer</p></div></div></td><td><p>Query parameter for the maximum number of records to retrieve per request. The minimum value is 0.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Integer</p></div></div></td><td><p>Query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.</p></td><td><p>25</p></td><td></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Get Variations For Master Product

`<commerce-cloud-dataapi:get-variations-for-master-product>`

Searches for gift certificates. The query attribute specifies a complex query that can be used to
narrow down the search. This operation makes an HTTP POST request to the
`/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates` endpoint.

This is the list of searchable attributes:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th><th>Sortable</th></tr></thead><tbody><tr><td><p>merchantId</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>maskedGiftCertificateCode *</p></td><td><p>String</p></td><td><p>no</p></td></tr><tr><td><p>orderNo</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>senderName</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>recipientName</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>recipientEmail</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>status</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>enabled</p></td><td><p>Boolean</p></td><td><p>yes</p></td></tr><tr><td><p>message</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>creationDate</p></td><td><p>Date</p></td><td><p>yes</p></td></tr><tr><td><p>currencyMnemonic **</p></td><td><p>String</p></td><td><p>yes</p></td></tr></tbody></table>

### Notes

- `maskedGiftCertificateCode`, also known as `code`, can only be used in a term query.  
  If a four-character code is supplied, it is assumed that the search is on the unmasked portion of
  the code, otherwise, the full code must be matched. Text queries are not allowed.

- `currencyMnemonic` can only be joined with other attributes using a conjunction (`AND`).

- Only searchable attributes can be used in sorting.

### 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><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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Promotions Search

`<commerce-cloud-dataapi:promotions-search>`

Searches for promotions. The SearchRequest document contains a search object that allows filtering
on various attributes.

The query attribute specifies a complex query that can be used to narrow down the search using the
following searchable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>name</p></td><td><p>String</p></td></tr><tr><td><p>currecyCode</p></td><td><p>String</p></td></tr><tr><td><p>exclusivity</p></td><td><p>String</p></td></tr><tr><td><p>enabled</p></td><td><p>Boolean</p></td></tr></tbody></table>

Note that only searchable attributes can be used in sorting. Additionally, the following attribute
can be used to sort:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>promotionClass</p></td><td><p>String</p></td></tr></tbody></table>

This operation makes an HTTP POST request to the
`/pricing/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>Name of the configuration to use.</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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Remove Address For Customer In Customer List

`<commerce-cloud-dataapi:remove-address-for-customer-in-customer-list>`

Action that deletes a customer address. This operation makes an HTTP POST request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}/addresses/{addressId}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>listId</p></td><td><div><div><p>String</p></div></div></td><td><p>List ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>addressId</p></td><td><div><div><p>String</p></div></div></td><td><p>Address ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>customerNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Customer number.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Search Catalogs

`<commerce-cloud-dataapi:search-catalogs>`

Searches for catalogs.

The query attribute specifies a complex query that can be used to narrow down the search with the
following searchable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>name</p></td><td><p>String</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr></tbody></table>

There are two additional fields that can be used as search filters. They are not attributes in the
`CatalogWO` object, but can be used as filters to query catalogs based on site assignments.

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>isMasterCatalog</p></td><td><p>Boolean</p></td></tr><tr><td><p>isStorefrontCatalog</p></td><td><p>Boolean</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr><tr><td><p>online</p></td><td><p>Boolean</p></td></tr><tr><td><p>position</p></td><td><p>Double</p></td></tr></tbody></table>

When isMasterCatalog is used in the search query, catalogs without any site assignments are
returned. When isStorefrontCatalog is used in the search query, catalogs with one or more site
assignments are returned.

The output of the query can also be sorted with the following sortable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>name</p></td><td><p>String</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr></tbody></table>

This operation makes an HTTP POST request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalog-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>Name of the configuration to use.</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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Search Categories

`<commerce-cloud-dataapi:search-categories>`

Searches for catalog categories anywhere they appear. By default, the server also returns the first
level of subcategories, but you can specify another level by setting the levels parameter. Please
note, using a large value for levels may cause performance issues with a large and deep category
tree. The query attribute specifies a complex query that can be used to narrow down the search with
the following searchable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>name</p></td><td><p>String</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr><tr><td><p>online</p></td><td><p>Boolean</p></td></tr><tr><td><p>catalogId</p></td><td><p>String</p></td></tr></tbody></table>

The output of the query can also be sorted with the following sortable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>name</p></td><td><p>String</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr><tr><td><p>online</p></td><td><p>Boolean</p></td></tr><tr><td><p>position</p></td><td><p>Double</p></td></tr></tbody></table>

This operation makes an HTTP POST request to the
`/product/catalogs/{version}/organizations/{organizationId}/category-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>Name of the configuration to use.</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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>levels</p></td><td><div><div><p>Integer</p></div></div></td><td><p>Level number. The minimum value is <code>0</code>.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Search Categories In Catalog

`<commerce-cloud-dataapi:search-categories-in-catalog>`

Searches for catalog categories in the scope of the catalog. By default, the server also returns the
first level of subcategories, but you can specify another level by setting the `levels` parameter.
Using a large value for `levels` can cause performance issues with a large and deep category tree.

The query attribute specifies a complex query that can be used to narrow down the search with the
following searchable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>name</p></td><td><p>String</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr><tr><td><p>online</p></td><td><p>Boolean</p></td></tr><tr><td><p>parentCategoryId</p></td><td><p>String</p></td></tr></tbody></table>

The output of the query can also be sorted with the following sortable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>name</p></td><td><p>String</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr><tr><td><p>online</p></td><td><p>Boolean</p></td></tr><tr><td><p>position</p></td><td><p>Double</p></td></tr></tbody></table>

This operation makes an HTTP POST request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/category-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>Name of the configuration to use.</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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the requested catalog</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>levels</p></td><td><div><div><p>Integer</p></div></div></td><td><p>Level number. The minimum value is <code>0</code>.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Search Customer In Customer List

`<commerce-cloud-dataapi:search-customer-in-customer-list>`

Action to search for customers in a customer list.

The query attribute specifies a complex query that can be used to narrow down the search. These are
the list of searchable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>customerNo</p></td><td><p>String</p></td></tr><tr><td><p>firstName</p></td><td><p>String</p></td></tr><tr><td><p>secondName</p></td><td><p>String</p></td></tr><tr><td><p>lastName</p></td><td><p>String</p></td></tr><tr><td><p>suffix</p></td><td><p>String</p></td></tr><tr><td><p>salutation</p></td><td><p>String</p></td></tr><tr><td><p>title</p></td><td><p>String</p></td></tr><tr><td><p>fax</p></td><td><p>String</p></td></tr><tr><td><p>phoneHome</p></td><td><p>String</p></td></tr><tr><td><p>phoneBusiness</p></td><td><p>String</p></td></tr><tr><td><p>phoneMobile</p></td><td><p>String</p></td></tr><tr><td><p>email</p></td><td><p>String</p></td></tr><tr><td><p>gender</p></td><td><p>Integer</p></td></tr><tr><td><p>companyName</p></td><td><p>String</p></td></tr><tr><td><p>credentials.login</p></td><td><p>String</p></td></tr><tr><td><p>credentials.enabled</p></td><td><p>Boolean</p></td></tr></tbody></table>

This operation makes an HTTP POST request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{customerListId}/customer-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>Name of the configuration to use.</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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>customerListId</p></td><td><div><div><p>String</p></div></div></td><td><p>Customer list ID in which to search.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Search Product Variations

`<commerce-cloud-dataapi:search-product-variations>`

Searches product variations for master product or variation group product.

The query attribute specifies a complex query that can be used to narrow down the search. The list
of searchable attributes includes:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th><th>Sortable</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>productId</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>name</p></td><td><p>String</p></td><td><p>yes</p></td></tr><tr><td><p>online</p></td><td><p>SiteSpecific Boolean</p></td><td><p>yes</p></td></tr><tr><td><p>inStock</p></td><td><p>Boolean</p></td><td><p>yes</p></td></tr><tr><td><p>searchable</p></td><td><p>SiteSpecific Boolean</p></td><td><p>yes</p></td></tr><tr><td><p>ats - Actual available quantity to sell</p></td><td><p>Double</p></td><td><p>yes</p></td></tr></tbody></table>

> [!NOTE] The calculated value of `online` and `searchable` is used in the search and sort. A search
> or sort by the site-specific attributes requires the Site ID query parameter to be set. The site
> ID query parameters are:

- `online`

- `inStock`

- `searchable`

- `ats`

It is assumed that every field that starts with `variationAttribute.` is searchable and the dot is
followed by "ATTRIBUTE\_ID".

This operation makes an HTTP POST request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/variant-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>Name of the configuration to use.</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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Search Products

`<commerce-cloud-dataapi:search-products>`

Searches for products. The query attribute specifies a complex query that can be used to narrow the
search. Attributes are grouped into different buckets.

The following is a list of searchable attributes with their corresponding buckets:

Main:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>name</p></td><td><p>String</p></td></tr><tr><td><p>online</p></td><td><p>SiteSpecific Boolean</p></td></tr><tr><td><p>searchable</p></td><td><p>SiteSpecific Boolean</p></td></tr><tr><td><p>validFrom</p></td><td><p>SiteSpecific DateTime</p></td></tr><tr><td><p>validTo</p></td><td><p>SiteSpecific DateTime</p></td></tr><tr><td><p>type</p></td><td><p>ProductType</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr></tbody></table>

Catalog:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>catalogId</p></td><td><p>String</p></td></tr></tbody></table>

Category:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th><th>Sortable</th></tr></thead><tbody><tr><td><p>categoryId</p></td><td><p>String</p></td><td><p>no</p></td></tr></tbody></table>

The sortable properties are:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th><th>Sortable</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td><td><p>name</p></td></tr><tr><td><p>String</p></td><td><p>creationDate</p></td><td><p>DateTime</p></td></tr></tbody></table>

This operation makes an HTTP POST request to the
`/product/products/{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>Name of the configuration to use.</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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Search Products Assigned To Category

`<commerce-cloud-dataapi:search-products-assigned-to-category>`

Searches for category product assignments. The query attribute specifies a complex query that can be
used to narrow the search.

The following are searchable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>productId</p></td><td><p>String</p></td></tr><tr><td><p>productName</p></td><td><p>String</p></td></tr><tr><td><p>onlineFlag</p></td><td><p>Boolean</p></td></tr><tr><td><p>searchable</p></td><td><p>Boolean</p></td></tr><tr><td><p>validFrom</p></td><td><p>DateTime</p></td></tr><tr><td><p>validTo</p></td><td><p>DateTime</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr></tbody></table>

Sortable Fields:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>productId</p></td><td><p>String</p></td></tr><tr><td><p>productName</p></td><td><p>String</p></td></tr><tr><td><p>position</p></td><td><p>Double</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr></tbody></table>

This operation makes an HTTP POST request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/category-product-assignment-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>Name of the configuration to use.</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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the category.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Source Code Groups Search

`<commerce-cloud-dataapi:source-code-groups-search>`

Searches for source code groups.

The query attribute specifies a complex query that can be used to narrow the search with the
following searchable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td></tr><tr><td><p>sourceCode</p></td><td><p>String</p></td></tr><tr><td><p>startTime</p></td><td><p>DateTime</p></td></tr><tr><td><p>endTime</p></td><td><p>DateTime</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr><tr><td><p>enabled</p></td><td><p>Boolean</p></td></tr><tr><td><p>active</p></td><td><p>Boolean</p></td></tr></tbody></table>

The `sourceCode` and `active` fields can only be used in queries as conjunctions (using `AND`). If
the field is used in a disjunction (`OR`), an exception will be thrown.

The output of the query can also be sorted, with the following sortable attributes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Type</th></tr></thead><tbody><tr><td><p>id</p></td><td><p>String</p></td></tr><tr><td><p>description</p></td><td><p>String</p></td></tr><tr><td><p>enabled</p></td><td><p>Boolean</p></td></tr><tr><td><p>creationDate</p></td><td><p>DateTime</p></td></tr></tbody></table>

This operation makes an HTTP POST request to the
`/pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups` 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><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>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the category.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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><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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Unassign Product From Category

`<commerce-cloud-dataapi:unassign-product-from-category>`

Removes a category product assignment.

For example, if products A, B, and C are at positions 1, 2, and 7.5 and you delete the assignment
for product B, the products A, B, and C move up one position, and position 7.5 is left null.

This operation makes an HTTP DELETE request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}`
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><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the category.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog,</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID (SKU) of the requested product to assign.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Unassign Variation From Master Product

`<commerce-cloud-dataapi:unassign-variation-from-master-product>`

Unassign a variation product from a product master. The variation product itself is not deleted; it
remains as a normal product after it is unassigned from product master.

This operation makes an HTTP DELETE request to the
`/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variations/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the master product that contains the variation group.</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>ID of the variation product.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Unassign Variation Group From Master Product

`<commerce-cloud-dataapi:unassign-variation-group-from-master-product>`

Unassign a variation group product from a product master. The variation group product itself is not
deleted; it remains as a normal product after it is unsassigned from the product master.

This operation makes an HTTP DELETE request to the
`/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variation-groups/{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>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>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the master product that contains the variation group.</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>ID of the variation group product.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Address For Customer In Customer List

`<commerce-cloud-dataapi:update-address-for-customer-in-customer-list>`

Action that updates an address of a customer with the given address information. This operation
makes an HTTP PATCH request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}/addresses/{addressId}`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>listId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the list with the customer address to update.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>addressId</p></td><td><div><div><p>String</p></div></div></td><td><p>Customer address ID.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>customerNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Customer number.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Campaign

`<commerce-cloud-dataapi:update-campaign>`

Updates the campaign with the specified information. This operation makes an HTTP PATCH request to
the `/pricing/campaigns/{version}/organizations/{organizationId}/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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>campaignId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the campaign.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Catalog

`<commerce-cloud-dataapi:update-catalog>`

Updates the catalog with the specified information. This operation makes an HTTP PATCH request to
the `/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Category In Catalog

`<commerce-cloud-dataapi:update-category-in-catalog>`

Updates a catalog category using the information provided. This operation makes an HTTP PATCH
request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the category to update.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Coupon

`<commerce-cloud-dataapi:update-coupon>`

Updates the coupon with the specified information. This operation makes an HTTP PATCH request to the
`/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>couponId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the coupon to update.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Coupon Codes

`<commerce-cloud-dataapi:update-coupon-codes>`

Add or delete (modify) multiple codes to and from the supplied coupon. This operation makes an HTTP
POST request to the
`/pricing/coupons/{version}/organizations/{organizationId}/coupons/{couponId}/codes` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>couponId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the coupon to update</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Customer In Customer List

`<commerce-cloud-dataapi:update-customer-in-customer-list>`

Updates the customer with the specified information. The customer number is allowed to be updated
but results in a `CustomerNumberAlreadyInUseException` if there is an existing customer with the
same customer number.

This operation makes an HTTP PATCH request to the
`/customer/customers/{version}/organizations/{organizationId}/customer-lists/{listId}/customers/{customerNo}`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>listId</p></td><td><div><div><p>String</p></div></div></td><td><p>List ID of the list to which the customer belongs.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>customerNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Customer number.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Gift Certificate

`<commerce-cloud-dataapi:update-gift-certificate>`

Updates the gift certificate with the specified information using merchant ID. This operation makes
an HTTP PATCH request to the
`/pricing/gift-certificates/{version}/organizations/{organizationId}/gift-certificates/{merchantId}`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>merchantId</p></td><td><div><div><p>String</p></div></div></td><td><p>Merchant ID of the requested gift certificate.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order

`<commerce-cloud-dataapi:update-order>`

Updates the order. This operation makes an HTTP PATCH request to the
`/checkout/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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order Confirmation Status

`<commerce-cloud-dataapi:update-order-confirmation-status>`

Updates the order confirmation status. This operation makes an HTTP PUT request to the
`/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/confirmation-status`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order Export Status

`<commerce-cloud-dataapi:update-order-export-status>`

Updates the order export status. Setting the status to `EXPORTED` also triggers the finalization of
on-order inventory transactions for this order, meaning that all inventory transactions with the
on-order type are moved into final inventory transactions. This is only relevant when on-order
inventory is turned on for the inventory list ordered products are in.

This operation makes an HTTP PUT request to the
`/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/export-status` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order External Status

`<commerce-cloud-dataapi:update-order-external-status>`

Updates the order external status. This operation makes an HTTP PUT request to the
`/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/external-status`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order Payment Instrument

`<commerce-cloud-dataapi:update-order-payment-instrument>`

Updates the payment instrument of an order. This operation makes an HTTP PATCH request to the
`/checkout/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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>paymentInstrumentId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the payment instrument.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order Payment Status

`<commerce-cloud-dataapi:update-order-payment-status>`

Updates the order payment status. This operation makes an HTTP PUT request to the
`/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-status`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order Payment Transaction

`<commerce-cloud-dataapi:update-order-payment-transaction>`

Updates the transaction of an order payment instrument. This operation makes an HTTP PATCH request
to the
`/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}/transaction`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>paymentInstrumentId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the payment instrument.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order Shipping Address

`<commerce-cloud-dataapi:update-order-shipping-address>`

Updates (create or replace) the order shipment address. This operation makes an HTTP PUT request to
the
`/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>shipmentId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the shipment.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order Shipping Status

`<commerce-cloud-dataapi:update-order-shipping-status>`

Updates the order shipping status. This operation makes an HTTP PUT request to the
`/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/shipping-status`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Order Status

`<commerce-cloud-dataapi:update-order-status>`

Updates the order status. Orders that are have statuses of NEW, COMPLETED, or CANCELLED cannot be
set to a status of CREATED or FAILED. This operation makes an HTTP PUT request to the
`/checkout/orders/{version}/organizations/{organizationId}/orders/{orderNo}/status` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>orderNo</p></td><td><div><div><p>String</p></div></div></td><td><p>Order number.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Product

`<commerce-cloud-dataapi:update-product>`

Update a product using the information provided.

Fields that can be updated include:

- name

- pageDescription

- longDescripton

- pageTitle

- pageKeywords

- brand

- ean

- upc

- manufactureSku

- manufactureName

- searchable

- unit

- onlineFlag

- defaultVariantId

This operation makes an HTTP PATCH request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}` 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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>Product 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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Product Category Assignment

`<commerce-cloud-dataapi:update-product-category-assignment>`

Updates the category product assignment with the specified information, such as position. As the
assigned position is a normalized target position, the product is assigned to a position so that the
order of positions is maintained.

For example, if products A, B, C, and D occupy positions 1, 2, 3, and 4 and you update product A
with a new position of 3, the end result is:

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Product</p></td><td><p>Position</p></td></tr><tr><td><p>B</p></td><td><p>1</p></td></tr><tr><td><p>C</p></td><td><p>2</p></td></tr><tr><td><p>A</p></td><td><p>3</p></td></tr><tr><td><p>D</p></td><td><p>4</p></td></tr></tbody></table>

If you then update product C to no position, the end result is:

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Product</p></td><td><p>Position</p></td></tr><tr><td><p>B</p></td><td><p>1</p></td></tr><tr><td><p>A</p></td><td><p>2</p></td></tr><tr><td><p>D</p></td><td><p>3</p></td></tr><tr><td><p>C</p></td><td><p>null</p></td></tr></tbody></table>

If there are n existing positioned assignments, updating a product to position >= n results in a new
assignment with a position such that the order of the positions is maintained.

This operation makes an HTTP PATCH request to the
`/product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}`
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><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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>catalogId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the requested catalog.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the category to update.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID (SKU) of the requested product to assign.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Product Option

`<commerce-cloud-dataapi:update-product-option>`

Updates a local product option with the information provided. This operation makes an HTTP PATCH
request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the product.</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>ID of the local or shared product option.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Product Option value

`<commerce-cloud-dataapi:update-product-option-value>`

Updates a local product option value with the information provided. This operation makes an HTTP
PATCH request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>optionId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the local product option.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>productId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the product.</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>ID of the local product option value.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Promotion

`<commerce-cloud-dataapi:update-promotion>`

Updates the promotion with the specified information. This operation makes an HTTP PATCH request to
the `/pricing/promotions/{version}/organizations/{organizationId}/promotions/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>ID of the promotion to update.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Source Code Group

`<commerce-cloud-dataapi:update-source-code-group>`

Updates the source code group with the specified information. This operation makes an HTTP PATCH
request to the
`/pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>ID of the source code group to update.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>siteId</p></td><td><div><div><p>String</p></div></div></td><td><p>Site ID used as a query parameter to query the data for a specific site.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Variation Attribute

`<commerce-cloud-dataapi:update-variation-attribute>`

Updates the variation attribute with the specified information. This operation makes an HTTP PATCH
request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productid</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the product.</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 variation attribute to update</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Variation Attribute Value

`<commerce-cloud-dataapi:update-variation-attribute-value>`

Updates the variation attribute value of a variation attribute of a master product. This operation
makes an HTTP PATCH request to the
`/product/products/{version}/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>productid</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the product.</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>ID of the variation attribute value.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>attributeId</p></td><td><div><div><p>String</p></div></div></td><td><p>Variation attribute 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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Variation For Master Product

`<commerce-cloud-dataapi:update-variation-for-master-product>`

Update a variation for a product master. This operation makes an HTTP PATCH request to the
`/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variations/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the master product that contains the variation group.</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>ID of the variation product.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Update Variation Group For Master Product

`<commerce-cloud-dataapi:update-variation-group-for-master-product>`

Update a variation group for a product master. This operation makes an HTTP PATCH request to the
`/product/products/{version}/organizations/{organizationId}/products/{masterProductId}/variation-groups/{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>Name of the configuration to use.</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><p><strong>X</strong></p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p><strong>X</strong></p></td></tr><tr><td><p>organizationId</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>masterProductId</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the master product that contains the variation group.</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>ID of the variation group product.</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>Name of the configuration to use to execute this component.</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>Timeout for the 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>Time unit that qualifies the Response Timeout.</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>An expression that evaluates against the operation’s output. The outcome of this expression 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">ReconnectForever</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>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA:UNSUPPORTED\_MEDIA\_TYPE

## Unauthorize

`<commerce-cloud-dataapi:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it’s impossible to
execute any operation for that user without repeating the authorization dance.

### 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><strong>X</strong></p></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></tbody></table>

### For Configurations

- [OAuth2 Configuration](#DataConfiguration)

### Throws

- DATA:BAD\_REQUEST

- DATA:CLIENT\_ERROR

- DATA:CONNECTIVITY

- DATA:INTERNAL\_SERVER\_ERROR

- DATA:NOT\_ACCEPTABLE

- DATA:NOT\_FOUND

- DATA:RETRY\_EXHAUSTED

- DATA:SERVER\_ERROR

- DATA:SERVICE\_UNAVAILABLE

- DATA:TIMEOUT

- DATA:TOO\_MANY\_REQUESTS

- DATA:UNAUTHORIZED

- DATA: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><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></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><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></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><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></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><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></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><div></div></td><td><div></div></td><td><div></div></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><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of truststore used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.</p></div></div></td><td><div></div></td><td><div></div></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><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of keystore used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>When the keystore 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></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the keystore.</p></div></div></td><td><div></div></td><td><div></div></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><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Only verify the last element of the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Try CRL first, instead of OCSP.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Do not use the secondary checking method (the one not selected before).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></div></div></td><td><div></div></td><td><div></div></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><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the truststore), if present.</p></div></div></td><td><div></div></td><td><div></div></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><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></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><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><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></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnectForever">ReconnectForever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></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 milliseconds to reconnect.</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><tr><td><p>blocking</p></td><td><p>Boolean</p></td><td><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></td><td><p>true</p></td><td></td></tr></tbody></table>

### ReconnectForever

<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 milliseconds to reconnect.</p></td><td></td><td></td></tr><tr><td><p>blocking</p></td><td><p>Boolean</p></td><td><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></td><td><p>true</p></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><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></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><div><div><p>Time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></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><strong>Status Code</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reason Phrase</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></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><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than fits into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size should expand if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, and a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than the specified size is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></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><div><div><p>The unit in which all these attributes are expressed</p></div></div></td><td><div></div></td><td><div></div></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><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><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></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></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><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

<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><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of instances that are initially allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.</p></div></div></td><td><div><div><p>100</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size should expand if it exceeds its initial specified size. Setting a value of zero or lower means that the buffer should not expand, and that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.</p></div></div></td><td><div><div><p>100</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than the specified size is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

<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><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of instances to keep in memory. If more than this is required, then it starts to buffer the content on to the disk.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></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><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=81467e70faf7f0b6ccf780d0510fd65f9787523f87937825f59ecc01a8d5011c url=/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-xml-maven.md -->

---
product: Salesforce Commerce Cloud B2C Data Connector
version: 1.0
is-latest-version: true
---

# Salesforce Commerce Cloud B2C Data Connector XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:

- If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
  editor or from a text editor, you can access the connector from your app by adding reference
  statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

- If you add the connector in Studio, Studio automatically populates the XML code with the
  connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `mule` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/commerce-cloud-dataapi
http://www.mulesoft.org/schema/mule/commerce-cloud-dataapi/current/mule-commerce-cloud-dataapi.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:commerce-cloud-dataapi="http://www.mulesoft.org/schema/mule/commerce-cloud-dataapi"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/commerce-cloud-dataapi
	http://www.mulesoft.org/schema/mule/commerce-cloud-dataapi/current/mule-commerce-cloud-dataapi.xsd">
</mule>
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
    <groupId>com.mulesoft.connectors</groupId>
    <artifactId>commerce-cloud-dataapi</artifactId>
    <version>x.x.x</version>
    <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `commerce cloud b2c`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## Next Step

After completing your namespace and `pom.xml` file, you can try the
[Example](https://docs.mulesoft.com/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-examples).

## See Also

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=e047e2fa8e7126b0474b69f390294daad0e3cb1faa52d8a70e121146581cfdce url=/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-studio.md -->

---
product: Salesforce Commerce Cloud B2C Data Connector
version: 1.0
is-latest-version: true
---

# Using Anypoint Studio to Configure Salesforce Commerce Cloud B2C Data Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-input-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

When you run the connector, you can view the app log to check for problems, as described in
[View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[B2C Data Connector Reference](https://docs.mulesoft.com/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add <connector name> to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and to add the required dependencies to the project’s
`pom.xml` file:

1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

2.  In the **Add Dependencies to Project** window, type `commerce cloud b2c` in the search field.

3.  Click **Commerce Cloud B2C Data Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these input
sources to use with B2C Data Connector:

- **HTTP > Listener**  
  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**  
  Initiates a flow when a time-based condition is met

For example, to configure an HTTP listener, follow these steps:

1.  In the **Mule Palette** view, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Specify a value for the **Path** field.

5.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the HTTP listener in the app.

6.  On the **General** tab, specify the connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you immediately define a specific operation for
that connector to perform.

To add an operation for B2C Data Connector, follow these steps:

1.  In the **Mule Palette** view, select **B2C Data Connector** and then select the desired
    operation.

2.  Drag the operation onto the Studio canvas and to the right of the input source.

## Configure a Global Element for the Connector

When you configure a connector, it’s best to configure a global element that all instances of that
connector in the app can use. Configuring a global element requires you to provide the
authentication credentials that the connector requires to access the target Commerce Cloud Data API
system. B2C Data Connector supports Oauth2 Application Connection Provider authentication for
connections.

To configure the global element for B2C Data Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the configuration screen for the operation, click the plus sign (+) next to the **Connector
    configuration** field to access the global element configuration fields.

3.  On the **General** tab, in **Connection**, select the **Oauth 2 Application Connection
    Provider** authentication method.

4.  Configure the following fields:

    - **Base Uri**  
      URI that accesses the Data API

    - **Client Id**  
      ID of the client account created with Salesforce Commerce

    - **Client Secret**  
      Secret of the client account created with Salesforce

    - **Token URL**  
      Access token URL

    - **Scopes**  
      Scopes for access to the Data API

      The following image shows an example of the **OAuth 2 Application Connection Provider**
      configuration:

      ![OAuth2 Application Connection Provider authentication configuration](/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/_images/data-api-connector-oauth2-configuration.jpg)

    You can reference a configuration file that contains ANT-style property placeholders
    (recommended), or you can enter your authorization credentials in the global configuration
    properties. For information about the benefits of using property placeholders and how to
    configure them, see
    [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

    \+ This example adds credentials to the application properties file and references it using
    placeholders.

5.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

6.  Click **Test Connection** to confirm that Mule can connect with the specified server.

    ![Test connection returning a Test connection successful message](/mulesoft/current/en-us/commerce-cloud-b2c-data-connector/latest/_images/data-api-connector-oauth2-test-connection.jpg)

7.  Click **OK**.

A successful OAuth2 Application Connection Provider configuration looks like this:

```xml
   <commerce-cloud-dataapi:config name="Commerce_Cloud_Data_Connector_Config" doc:name="Commerce Cloud Data Connector Config" >
		<commerce-cloud-dataapi:am-oauth2-connection baseUri="${data.baseUri}" >
			<commerce-cloud-dataapi:oauth-client-credentials clientId="${data.clientId}" clientSecret="${data.clientSecret}" tokenUrl="${data.tokenUrl}" scopes="${data.scopes}"/>
		</commerce-cloud-dataapi:am-oauth2-connection>
   </commerce-cloud-dataapi:config>
```

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio
  console window.

- If you’re running the app using Mule from the command line, the app log is visible in your OS
  console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`.

## Next Step

After you configure a global element and connection information, you can try the
[example](https://docs.mulesoft.com/commerce-cloud-b2c-data-connector/latest/commerce-cloud-b2c-data-connector-examples) for the connector.

## See Also

- [Salesforce Help](https://help.salesforce.com)