Elastic Path Commerce Cloud Component

You can use the Elastic Path Commerce Cloud component to perform tasks within Elastic Path Commerce Cloud, for example, publish catalogs, import products, assign products to nodes and so on.

Connections

Collect the following Elastic Path Commerce Cloud API keys. You can find this information in SYSTEM > Application Keys in Commerce Manager when logged in as a user with Seller Admin privileges.

Elastic Path Commerce Cloud API Key	Description
API Base URL	Your Elastic Path Commerce Cloud API Base URL.
Client ID	Your Elastic Path Commerce Cloud Client ID.
Client Secret	Your Elastic Path Commerce Cloud Client Secret.

Triggers

Elastic Path Commerce Cloud Webhook

A webhook trigger to consume HTTP webhooks from Elastic Path Commerce Cloud. Supports authentication via the webhook Secret Key which is passed to webhooks within the X-MOLTIN-SECRET-KEY HTTP header.

Input	Description
Webhook Secret Key	Required The API secret used to authenticate calls to the webhook. A default value is provided that is randomly generated by the NodeJS crypto library.
Response Type	Select Synchronous if the webhook response must be sent back to Elastic Path Commerce Cloud. Select Asynchronous if the webhook must send an immediate response to Elastic Path Commerce Cloud containing the execution ID before processing the event.
Error Handler Type	Select the preferred behavior for error handling.
Retry	Select if the flow must be automatically retried if an error is returned. Only applies if the Response Type is Asynchronous.
Retry Attempts	Specify the maximum number of times the request must be processed if errors are returned. Only applies if the Response Type is Asynchronous.
Minutes Between Attempts	Specify how many minutes to wait between retries. Only applies if the Response Type is Asynchronous.
Exponential Backoff	Wait twice as long between each retry. Only applies if the Response Type is Asynchronous.
Retry Cancellation	Report or ignore the error if the final retry fails. Only applies if the Response Type is Asynchronous.

Actions

The component has the following actions.

Allocate Inventory

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Quantity	string	The amount of the product to allocate.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Cancel Transaction

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Order ID	string	The unique identifier of the order.
Transaction ID	string	The unique identifier of the transaction.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Capture Transaction

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Order ID	string	The unique identifier of the order.
Transaction ID	string	The unique identifier of the transaction.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Refund Transaction

Input	Type	Description
Connection	connection	Elastic Path Composable Commerce connection.
Order ID	string	The unique identifier of the order.
Transaction ID	string	The unique identifier of the transaction.
Amount	string	The amount value to be refunded.
Override Token	string	The output of Generate Override Token action to be used with organizations.

Create a Field

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
name	string	The name of the field.
slug	string	A unique slug identifier for the field.
field_type	string	This field is immutable and cannot be updated. Types of fields are: string, integer, boolean, float, date, or relationship.
description	string	Any description for this field.
required	boolean	true if required on input, false if not. Always false if the field_type is a relationship.
enabled	boolean	If this field is enabled on the flow this must be true, otherwise false.
flow_id	string	The unique identifier of the flow that the field belongs to.
default	string	A default value if none is supplied and field is not required.
order	string	Denotes the order in which this field is returned relative to the rest of the flow fields.
omit_null	boolean	Hide this field from responses if the value is null.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create a File (By Location)

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
File Location	string	Location of the file.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create a Pricebook

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Name	string	The name of the price book.
Description	string	The purpose for the price book, such as flash sale pricing or preferred customer pricing.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create a Price in a Pricebook

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Pricebook ID	string	The unique identifier of the pricebook.
SKU	string	The product SKU that the prices belongs to.
Currencies	string	A collection of one or more currencies.
Sales	string	A collection of one or more sales.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create Account

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Account Request	string	The API request to create an account. Avoid using data parameter in the request.

For Account Request, see the following snippet:

  {
    "type": "account",
    "name": "acc-name",
    "legal_name": "acc-legal-name",
    "registration_id": "00000000-0000-1000-8000-000f00000300",
    "external_ref": "16bedceb-8b2d-4f82-a973-b0a8d8432708",
    "parent_id": "96b1f750-55d3-4768-a3f8-adffba694a2c"
  }

Create Account Address

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Account ID	string	The unique identifier for an Account.
Account Address Request	string	The API request to create an account address. Avoid using data parameter in the request.

For Account Address Request, see the following snippet:

  {
    "type": "address",
    "name": "Home",
    "first_name": "Ron",
    "last_name": "Swanson",
    "company_name": "",
    "phone_number": "(555) 555-1234",
    "line_1": "1 Sunny Street",
    "line_2": "Sunny Place",
    "city": "Sunny Town",
    "postcode": "SU33 1YY",
    "county": "Sunnyville",
    "region": "Peterborough",
    "country": "GB",
    "instructions": "Leave in the shed"
  }

Create Customer

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Customer Request	string	The API request to create a customer. Avoid using data parameter in the request.

For Customer Request, see the following snippet:

  {
    "type": "customer",
    "name": "Ron Swanson",
    "email": "ron@swanson.com",
    "external_ref": "16bedceb-8b2d-4f82-a973-b0a8d8432708",
    "password": "mysecretpassword"
  }

Create Flow

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Name	string	The name of the flow.
description	string	Any description for this flow.
slug	string	A unique slug identifier for the flow.
enabled	boolean	true if enabled, false if not.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create Flow Entry

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
flow_fields Inputs	string
flow_slug	string	A unique slug identifier for the flow.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create Hierarchies

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Name	string	The name of the hierarchy.
slug	string	A unique slug for the hierarchy.
Description	string	A description of the hierarchy.
locales	string	The hierarchy details localized in the supported languages. For example, hierarchy names or descriptions.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create Integration

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
name	string	Specifies the name of the integration.
description	string	Specifies a description for the integration.
integration_type	string	Specifies how the integration is delivered, either webhook, aws_sqs, or stomp.
enabled	boolean	Specifies whether the integration is enabled.
observes object	dynamicfieldselection	Specifies an array of observable events.
configuration	string	Specifies a configuration.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

yarn

Create Inventory

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Quantity	string	The amount of product available.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create Main Image Relationship

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
File Id	string	The unique identifier of the image file.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create OIDC Profile

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Authentication realm Id	string	The ID for the authentication realm.
OIDC Profile Name	string	The name of the OpenID Connect profile.
OIDC Profile Discovery Url	string	The URL of the OpenID Connect discovery document.
OIDC Profile Client Id	string	The client ID for the OpenID Provider.
OIDC Profile Client Secret	string	The client secret for the OpenID Provider.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create Product

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Name	string	The name of the product.
SKU	string	The unique stock keeping unit of the product.
Slug	string	The unique slug of the product.
Description	string	The description of the product.
Status	string	Whether the product is live or draft.
Commodity Type	string	The commodity type, either physical or digital.
MPN	string	The manufacturer part number of the product.
UPC EAN	string	The universal product code or european article number of the product.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create Template Relationship

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Template Id	string	The unique identifier of the template.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Deallocate Inventory

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Quantity	string	The number of products to deallocate.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Decrement Inventory

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Quantity	string	The number of products to decrement.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Delete Account

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Account ID	string	The unique identifier for an Account.

Delete Account Address

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Account ID	string	The unique identifier for an Account.
Account Address ID	string	The unique identifier for an account address.

Delete a Price Currency

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Currency Id	string	The unique identifier of the currency.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Delete a Price in a Pricebook

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Pricebook Id	string	The unique identifier of the pricebook.
Price Id	string	The unique identifier of the product price.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Delete Customer

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Customer Id	string	The unique identifier of the customer.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Delete Integration by ID

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Integration Id	string	The unique identifier of the integration.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Duplicate Hierarchies

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Integration Id	string	The unique identifier of the integration.
Integration Id	string	The unique identifier of the integration.
Integration Id	string	The unique identifier of the integration.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Generate Override Token action

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.

Generate Token via Password

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Email	string	The customer email.
Password	string	The customer password.
Headers	string	The Bearer token required to get access to the API.

Generate Token via OIDC

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Code	string	The code returned from the OpenID Connect Provider authentication.
Redirect Uri	string	The url of the front-end that handles the callback of the token.
Code Verifier	string	The customer password.
Headers	string	The Bearer token required to get access to the API.

Get a Catalog Product

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Includes	array	Any related types that must be included in the response. For example, files, main_image, and so on.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Customer Attributes

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get a File

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
File Id	string	The unique identifier of the file.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get a Flow Entry

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Flow Slug	string	A unique slug identifier for the flow.
Entry ID	string	A unique identifier for the entry.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get all Catalog Products

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Includes	array	Any related types that must be included in the response. For example, files, main_image, and so on.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get all Catalogs

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get all Customers

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Fields on a Flow

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Flow Slug	string	A unique slug identifier for the flow.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Flow Entries

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Flow Slug	string	A unique slug identifier for the flow.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
Offset	string	The current offset by number of records, not pages. Offset is zero-based.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Hierarchies

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Catalog Id	string	The unique identifier of the catalog.
Release Id	string	The unique identifier of the catalog release.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
Offset	string	The current offset by number of records, not pages. Offset is zero-based.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Integrations

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
Offset	string	The current offset by number of records, not pages. Offset is zero-based.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Nodes (with Catalog ID)

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Catalog Id	string	The unique identifier of the catalog.
Release Id	string	The unique identifier of the catalog release.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
Offset	string	The current offset by number of records, not pages. Offset is zero-based.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All OIDC Profiles

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Authentication Realm Id	string	A unique slug identifier for the authentication realm.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Pricebooks

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Stores

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
Offset	string	The current offset by number of records, not pages. Offset is zero-based.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Transactions

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Order Id	string	A unique slug identifier for the order.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Variations

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
Offset	string	The current offset by number of records, not pages. Offset is zero-based.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get A Pricebook

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Pricebook Id	string	A unique slug identifier for the pricebook.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get a Transaction by Order ID

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Order Id	string	A unique slug identifier for the order.
Transaction Id	string	A unique slug identifier for the transaction.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Catalog Releases

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Catalog Id	string	The unique identifier of the catalog.
Release Id	string	The unique identifier of the catalog release.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Currencies

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Customer

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Customer Id	string	The unique identifier of the customer.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Customer Authentication Settings

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Inventory

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Merchant Realm Mapping

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Multiple Files

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
File Ids	string	The unique identifier of the files.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Mulitple Inventory

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Ids	string	The unique identifier of the products.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Multiple Product by IDs (Shopper Catalog)

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Ids	string	The unique identifier of the products.
Includes	array	Any related types that must be included in the response. For example, files, main_image, and so on.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Order by ID

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Order Id	string	The unique identifier of the order.
Includes	array	Any related types that must be included in the response. For example, files, main_image, and so on.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Orders

Get a page of orders.

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100. Defaults to 25, unless overriden in store settings.
Offset	string	The current offset by number of records, not pages. Offset is zero-based.
Filter Type	string	The type of filter to apply to this query. All 3 filter fields must be provided or else the filter settings are ignored.
Filter Field	string	The field to specify in the filter.
Filter Field Value	string	The value to specify in the filter.
Includes	string	Any related types that must be included in the response.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Order Items By Order ID

Input	Type	Description
Connection	connection	Elastic Path Composable Commerce connection.
Order Id	string	The unique identifier of the order.
Override Token	string	The output of Generate Override Token action to be used with organizations.

Update Order

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Order Id	string	The unique identifier of the order.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Order Request	string	The API request to update an order. Avoid using data parameter in the request.

For Order Request, see the following snippet:

  {
    "type": "order",
    "shipping_address": {
      "first_name": "Ron"
    }
  }

Get Product by ID (PXM)

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Product by ID (Shopper Catalog)

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
EP-Channel	string	The channel, such as website or mobile app. Corresponds to the channel attribute in a Rule.
EP-Context-Tag	string	A tag defined in the store, such as clearance. Corresponds to the tag attribute in a Rule.
X-MOLTIN-CURRENCY	string	For projects that support multiple currencies, use x-moltin-currency that contains the formatting detail for all currencies available to the catalog.
Includes	array	Any related types that must be included in the response. For example, files, main_image, and so on.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Product by ID (with Catalog ID)

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Catalog Id	string	The unique identifier of the catalog.
Release Id	string	The unique identifier of the catalog release.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Product by SKU (PXM)

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
SKU	string	The unique SKU of the product.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Product by SKU (Shopper Catalog)

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
SKU	string	The unique SKU of the product.
EP-Channel	string	The channel, such as website or mobile app. Corresponds to the channel attribute in a Rule.
EP-Context-Tag	string	A tag defined in the store, such as clearance. Corresponds to the tag attribute in a Rule.
X-MOLTIN-CURRENCY	string	For projects that support multiple currencies, use x-moltin-currency that contains the formatting detail for all currencies available to the catalog.
Includes	array	Any related types that must be included in the response. For example, files, main_image, and so on.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Products in Node (With Catalog ID)

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Catalog Id	string	The unique identifier of the catalog.
Release Id	string	The unique identifier of the catalog release.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
Offset	string	The current offset by number of records, not pages. Offset is zero-based.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Organization Id

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Increment Inventory

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Quantity	string	The amount of the product to increment.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Switch Session To Organization

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Organization Id	string	The unique identifier of the organization to be switched to when using an organization session token.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Switch Session To Store

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Store Id	string	The unique identifier of the store to be switched to when using an organization session token.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Update a Pricebook

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Name	string	Specifies the name of the pricebook.
Description	string	Specifies a description for the pricebook.
Pricebook Id	string	The unique identifier of the pricebook.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Update a Price in a Pricebook

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Pricebook Id	string	The unique identifier of the pricebook.
SKU	string	Specifies the SKU of the pricebook.
Currencies	string	Specifies the updated currencies for the pricebook.
Sales	string	Specifies the updated sales for the pricebook.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Update Account

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Account ID	string	The unique identifier for an account.
Account Request	string	The API request to update an account. Avoid using data parameter in the request.

For Account Request, see the following snippet:

  {
    "type": "account",
    "name": "acc-name",
    "legal_name": "acc-legal-name",
    "registration_id": "00000000-0000-1000-8000-000f00000300"
  }

Update Account Address

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Account ID	string	The unique identifier for an Account.
Account Address ID	string	The unique identifier for an account address.
Account Address Request	string	The API request to update an account address. Avoid using data parameter in the request.

For Account Address Request, see the following snippet:

  {
    "type": "address",
    "first_name": "Ron"
  }

Update Authentication Realm

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Authentication Realm Id	string	The unique identifier of the authentication realm.
Redirect URL	string	An array of Storefront URIs that can start Single Sign On authentication. These URIs must follow the rules for redirection endpoints in OAuth 2.0. All URIs must start with https:// except for http://localhost.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Update Customer

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Customer ID	string	The unique identifier for a customer.
Customer Request	string	The API request to update a customer. Avoid using data parameter in the request.

For Customer Request, see the following snippet:

  {
    "type": "customer",
    "email": "ron@swanson.com"
  }

Update Flow Entry

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Entry Id	string	The unique identifier of the entry.
Flow Fields	string	The flow fields to update.
Flow Slug	string	The unique slug of the flow whose entry you want to update.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Update Merchant Realm Mapping

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Authentication Realm Id	string	The unique identifier of the authentication realm.
Merchant Mapping Prefix	string	The store prefix that is assigned to this merchant realm mapping. This can be null if a store prefix has not been assigned.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Update OIDC Profile

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Authentication realm Id	string	The ID for the authentication realm.
OIDC Profile Name	string	The name of the OpenID Connect profile.
OIDC Profile Discovery Url	string	The URL of the OpenID Connect discovery document.
OIDC Profile Client Id	string	The client ID for the OpenID Provider.
OIDC Profile Client Secret	string	The client secret for the OpenID Provider.
OIDC Profile Id	string	The ID for the OIDC Profile.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Update Product

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Product Id	string	The unique identifier of the product.
Name	string	The name of the product.
SKU	string	The unique stock keeping unit of the product.
Slug	string	The unique slug of the product.
Description	string	The description of the product.
Status	string	Whether the product is live or draft.
Commodity Type	string	The commodity type, either physical or digital.
MPN	string	The manufacturer part number of the product.
UPC EAN	string	The universal product code or european article number of the product.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Promotion by Id

Find a promotion by unique identifier.

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Promotion ID	string	The ID of the promotion.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Promotion by Name

Find a promotion with the given name. The action uses an exact, case-sensitive match to find the promotion.

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Promotion Name	string	The exact case-senstive name of the promotion.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get All Promotions

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100. Defaults to 25, unless overriden in store settings.
Offset	string	The current offset by number of records, not pages. Offset is zero-based. Default is zero.
Filter Type	string	The type of filter to apply to this query. All 3 filter fields must be provided or else the filter settings are ignored.
Filter Field	string	The field to specify in the filter.
Filter Field Value	string	The value to specify in the filter.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Account by ID

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Account ID	string	The unique identifier for an Account.

Get Account Address by ID

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Account ID	string	The unique identifier for an Account.
Account Address ID	string`	The unique identifier for an account address.

Get Account Attributes

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Get Paged Accounts

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
offset	string	The current offset by number of records, not pages. Offset is zero-based.
Filter Type	string	The type of filter to apply to this query. All 3 filter fields must be provided or else the filter settings are ignored.
Filter Field	string	The field to specify in the filter.
Filter Field Value	string	The value to specify in the filter.

Get Paged Account Addresses

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Override Token	string	The output of Generate Override Token action to be used with Organizations.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
offset	string	The current offset by number of records, not pages. Offset is zero-based.
Account ID	string	The unique identifier for an Account.

Get Paged Customers

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Limit	string	The maximum number of records per page for this response. You can set this value up to 100.
offset	string	The current offset by number of records, not pages. Offset is zero-based.
Filter Type	string	The type of filter to apply to this query. All 3 filter fields must be provided or else the filter settings are ignored.
Filter Field	string	The field to specify in the filter.
Filter Field Value	string	The value to specify in the filter.

Get Promotion Code Usages

Get the usages details for a given promotion code.

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Promotion ID	string	The ID of the promotion.
Promotion Code	string	The promotion code to query for usage details.
Override Token	string	The output of Generate Override Token action to be used with Organizations.

Create Promotion Code

Creates a new promotion code for an existing promotion.

Input	Type	Description
Connection	connection	Elastic Path Commerce Cloud connection.
Promotion ID	string	The ID of the promotion.
Promotion Code	string	The new promotion code to create.
Allowed Customer Ids	string	The UUIDs of customers that are allowed to redeem the promotion.
Max Usage Count	string	The maximum number of times a promotion can be applied.
Consume Unit	string	Indicates how the promotion should be applied.
Override Token	string	The output of Generate Override Token action to be used with Organizations.