Salesforce Commerce Cloud B2C Data Connector Reference - Mule 4

Support Category: Select

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.

OAuth2 Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

X

Connection

The connection types to provide to this configuration.

X

Response Timeout

Number

Timeout for the request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

MINUTES

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Oauth2 Application Connection Provider

Parameters

Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Connection Timeout

Number

The timeout for establishing connections to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Connection Timeout.

SECONDS

Use Persistent Connections

Boolean

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

true

Max Connections

Number

The maximum number of outbound connections to keep open concurrently.

-1

Connection Idle Timeout

Number

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

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the connection Idle Timeout.

SECONDS

Proxy Config

Reusable configuration element for outbound connections through a proxy.

Stream Response

Boolean

Whether or not to stream received responses.

false

Response Buffer Size

Number

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

-1

Base Uri

String

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

default base URI

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

Tls

Reconnection

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

Client Id

String

The OAuth client ID as registered with the service provider. Contact Salesforce for this information.

X

Client Secret

String

The OAuth client secret as registered with the service provider. Contact Salesforce for this information.

X

Token Url

String

The service provider’s token endpoint URL.

default token URL

Scopes

String

OAuth scopes to request during the OAuth dance.

X

Object Store

String

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.

Operations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

productId

String

Product ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for a request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors..

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

masterProductId

String

Master product ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

masterProductId

String

Master product ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors..

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component

X

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors..

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

campaignId

String

The ID of the campaign

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout..

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

catalogId

String

ID of the requested catalog.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

couponId

String

ID of the coupon to create.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

listId

String

List ID to which to add the customer.

X

customerNo

String

Customer number.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

listId

String

List ID to which to add the customer.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use..

#[payload]

X

version

String

API version..

X

organizationId

String

Organization ID..

X

productId

String

Product ID.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

id

String

ID of the local or shared product option.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

optionId

String

ID of the local product option.

X

id

String

ID of the local product option value.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

id

String

ID of the promotion to create.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

id

String

The ID of the source code group to create

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

The ID of the product

X

id

String

The ID of the variation attribute

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

ID of the product.

X

id

String

ID of the variation attribute value.

X

attributeId

String

Variation attribute ID.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

campaignId

String

ID of the campaign.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

ID of the requested catalog.

X

categoryId

String

ID of the category to create.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

couponId

String

ID of the coupon to delete.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

listId

String

List ID from which to delete the customer.

X

customerNo

String

Customer number.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

merchantId

String

Merchant ID of the requested gift certificate.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site..

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

id

String

The ID of the local or shared product option

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

id

String

The ID of the local product option value

X

optionId

String

The ID of the local product option

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

id

String

ID of the promotion to delete.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

id

String

The ID of the source code group to delete

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

The ID of the product

X

id

String

The ID of the variation attribute to delete

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

The ID of the product

X

attributeId

String

The variation attribute ID

X

id

String

The ID of the variation attribute value

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

customerNo

String

Customer number.

X

listId

String

List Id for the list from which to return the customer.

X

limit

Integer

The query parameter. Maximum number of records to retrieve per request. The minimum value is 0.

0

offset

Integer

The query parameter. Used to retrieve the results based on a particular resource offset. The maximum value is 50.

25

addressId

String

The address Id

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

customerNo

String

Customer number.

X

listId

String

List ID.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

ID of the requested catalog.

X

categoryId

String

ID of the category to be created.

X

productId

String

ID (SKU) of the requested product to assign.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

campaignId

String

ID of the campaign.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

ID of the requested catalog.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

ID of the requested catalog.

X

limit

Integer

The query parameter. Maximum records to retrieve per request. The minimum value is 0.

0

offset

Integer

The query parameter. Used to retrieve the results based on a particular resource offset. The maximum value is 50.

25

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

ID of the requested catalog.

X

limit

Integer

The query parameter. Maximum records to retrieve per request. The minimum value is 0.

0

offset

Integer

The query parameter. Used to retrieve the results based on a particular resource offset. The maximum value is 50.

25

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

The ID of the requested catalog

X

categoryId

String

The ID of the category to be created

X

levels

Integer

Level number query parameter. The minimum value is 0.

0

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

couponId

String

ID of the coupon.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

couponId

String

ID of the coupon.

X

limit

Integer

Maximum records to retrieve per request query parameter. The minimum value is 0.

0

offset

Integer

The query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.

25

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

listId

String

The list Id

X

customerNo

String

The customer number

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

merchantId

String

Merchant ID of the requested gift certificate.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

id

String

ID of the local or shared product option.

X

currency

String

Query parameter for currency.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

id

String

ID of the local product option value.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

limit

Integer

The query parameter for maximum number of records to retrieve per request. The minimum value is 0.

0

offset

Integer

The query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.

25

currency

String

The query param for currency

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

id

String

The ID of the promotion to get

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

id

String

ID of the source code group to get.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

The ID of the product

X

id

String

The ID of the variation attribute to get

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

The ID of the product

X

id

String

ID of the variation attribute value.

X

attributeId

String

Variation attribute ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

The ID of the product

X

limit

Integer

The query parameter for the maximum number of records to retrieve per request. The minimum value is 0.

0

offset

Integer

The query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.

25

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

masterProductId

String

ID of the master product that contains the variation group.

X

id

String

ID of the variation product.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

masterProductId

String

ID of the master product that contains the variation group.

X

id

String

ID of the variation group product.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

masterProductId

String

ID of the master product that contains the variation group.

X

limit

Integer

Query parameter for the maximum number of records to retrieve per request. The minimum value is 0.

0

offset

Integer

Query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.

25

siteId

String

Site ID used as a query parameter to query the data for a specific site.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

masterProductId

String

ID of the master product that contains the variation group.

X

limit

Integer

Query parameter for the maximum number of records to retrieve per request. The minimum value is 0.

0

offset

Integer

Query parameter used to retrieve the results based on a particular resource offset. The maximum value is 50.

25

siteId

String

Site ID used as a query parameter to query the data for a specific site.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type Sortable

merchantId

String

yes

maskedGiftCertificateCode *

String

no

orderNo

String

yes

senderName

String

yes

recipientName

String

yes

recipientEmail

String

yes

status

String

yes

enabled

Boolean

yes

message

String

yes

description

String

yes

creationDate

Date

yes

currencyMnemonic **

String

yes

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type

id

String

name

String

currecyCode

String

exclusivity

String

enabled

Boolean

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

Attribute Type

promotionClass

String

This operation makes an HTTP POST request to the /pricing/promotions/{version}/organizations/{organizationId}/promotions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

listId

String

List ID.

X

addressId

String

Address ID.

X

customerNo

String

Customer number.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type

id

String

name

String

description

String

creationDate

DateTime

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.

Attribute Type

isMasterCatalog

Boolean

isStorefrontCatalog

Boolean

description

String

creationDate

DateTime

online

Boolean

position

Double

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:

Attribute Type

id

String

name

String

description

String

creationDate

DateTime

This operation makes an HTTP POST request to the /product/catalogs/{version}/organizations/{organizationId}/catalog-search endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type

id

String

name

String

description

String

creationDate

DateTime

online

Boolean

catalogId

String

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

Attribute Type

id

String

name

String

description

String

creationDate

DateTime

online

Boolean

position

Double

This operation makes an HTTP POST request to the /product/catalogs/{version}/organizations/{organizationId}/category-search endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

levels

Integer

Level number. The minimum value is 0.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type

id

String

name

String

description

String

creationDate

DateTime

online

Boolean

parentCategoryId

String

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

Attribute Type

id

String

name

String

description

String

creationDate

DateTime

online

Boolean

position

Double

This operation makes an HTTP POST request to the /product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/category-search endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

The ID of the requested catalog

X

levels

Integer

Level number. The minimum value is 0.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type

customerNo

String

firstName

String

secondName

String

lastName

String

suffix

String

salutation

String

title

String

fax

String

phoneHome

String

phoneBusiness

String

phoneMobile

String

email

String

gender

Integer

companyName

String

credentials.login

String

credentials.enabled

Boolean

This operation makes an HTTP POST request to the /customer/customers/{version}/organizations/{organizationId}/customer-lists/{customerListId}/customer-search endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

customerListId

String

Customer list ID in which to search.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type Sortable

id

String

yes

productId

String

yes

name

String

yes

online

SiteSpecific Boolean

yes

inStock

Boolean

yes

searchable

SiteSpecific Boolean

yes

ats - Actual available quantity to sell

Double

yes

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type

id

String

name

String

online

SiteSpecific Boolean

searchable

SiteSpecific Boolean

validFrom

SiteSpecific DateTime

validTo

SiteSpecific DateTime

type

ProductType

creationDate

DateTime

Catalog:

Attribute Type

catalogId

String

Category:

Attribute Type Sortable

The sortable properties are:

Attribute Type Sortable

id

String

name

String

creationDate

DateTime

This operation makes an HTTP POST request to the /product/products/{version}/organizations/{organizationId}/product-search endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type

productId

String

productName

String

onlineFlag

Boolean

searchable

Boolean

validFrom

DateTime

validTo

DateTime

creationDate

DateTime

Sortable Fields:

Attribute Type

productId

String

productName

String

position

Double

creationDate

DateTime

This operation makes an HTTP POST request to the /product/catalogs/{version}/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/category-product-assignment-search endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

categoryId

String

ID of the category.

X

catalogId

String

ID of the requested catalog.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Attribute Type

id

String

description

String

sourceCode

String

startTime

DateTime

endTime

DateTime

creationDate

DateTime

enabled

Boolean

active

Boolean

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:

Attribute Type

id

String

description

String

enabled

Boolean

creationDate

DateTime

This operation makes an HTTP POST request to the /pricing/source-code-groups/{version}/organizations/{organizationId}/source-code-groups endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

version

String

API version.

X

organizationId

String

Organization ID.

X

categoryId

String

ID of the category.

X

catalogId

String

ID of the requested catalog.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

categoryId

String

ID of the category.

X

catalogId

String

ID of the requested catalog,

X

productId

String

ID (SKU) of the requested product to assign.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

masterProductId

String

ID of the master product that contains the variation group.

X

id

String

ID of the variation product.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

version

String

API version.

X

organizationId

String

Organization ID.

X

masterProductId

String

ID of the master product that contains the variation group.

X

id

String

ID of the variation group product.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

listId

String

ID of the list with the customer address to update.

X

addressId

String

Customer address ID.

X

customerNo

String

Customer number.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

campaignId

String

ID of the campaign.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

ID of the requested catalog.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

ID of the requested catalog.

X

categoryId

String

ID of the category to update.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

couponId

String

ID of the coupon to update.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

couponId

String

ID of the coupon to update

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

listId

String

List ID of the list to which the customer belongs.

X

customerNo

String

Customer number.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

merchantId

String

Merchant ID of the requested gift certificate.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

paymentInstrumentId

String

ID of the payment instrument.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

paymentInstrumentId

String

ID of the payment instrument.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

shipmentId

String

ID of the shipment.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

orderNo

String

Order number.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

Product ID.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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:

Product

Position

B

1

C

2

A

3

D

4

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

Product

Position

B

1

A

2

D

3

C

null

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

catalogId

String

ID of the requested catalog.

X

categoryId

String

ID of the category to update.

X

productId

String

ID (SKU) of the requested product to assign.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productId

String

ID of the product.

X

id

String

ID of the local or shared product option.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

optionId

String

ID of the local product option.

X

productId

String

ID of the product.

X

id

String

ID of the local product option value.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

id

String

ID of the promotion to update.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

id

String

ID of the source code group to update.

X

siteId

String

Site ID used as a query parameter to query the data for a specific site.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productid

String

ID of the product.

X

id

String

The ID of the variation attribute to update

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

productid

String

ID of the product.

X

id

String

ID of the variation attribute value.

X

attributeId

String

Variation attribute ID.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

masterProductId

String

ID of the master product that contains the variation group.

X

id

String

ID of the variation product.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Content

Binary

Content to use.

#[payload]

X

version

String

API version.

X

organizationId

String

Organization ID.

X

masterProductId

String

ID of the master product that contains the variation group.

X

id

String

ID of the variation group product.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Target Variable

String

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

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

For Configurations

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

Field Type Description Default Value Required

Key

String

x

Value

String

x

Default Query Param

Field Type Description Default Value Required

Key

String

x

Value

String

x

Proxy

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

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

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

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

Password

String

The password used to protect the truststore.

Type

String

The type of truststore used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

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

Key Store

Field Type Description Default Value Required

Path

String

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

Type

String

The type of keystore used.

Alias

String

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.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL first, instead of OCSP.

No Fallback

Boolean

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

Soft Fail

Boolean

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

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

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

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

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.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

ReconnectForever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

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

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the maxIdleTime attribute

HTTP Response Attributes

Field Type Description Default Value Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

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.

Buffer Size Increment

Number

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.

Max Buffer Size

Number

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.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

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

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

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.

100

Buffer Size Increment

Number

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.

100

Max Buffer Size

Number

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.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

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.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed