EP PXM Products API
With the Product Experience Manager (EP PXM) services, you define your products separately from catalogs, prices, inventory, and other resource relationships.
The product Object
| Name | Type | Description |
|---|---|---|
id | string | A unique product ID that is generated when you create the product. |
type | string | The type of resource object. You must use product. |
attributes | object | The attributes that describe the product. |
The product_attributes Object
The product attributes that can be displayed in your storefront.
| Name | Type | Description |
|---|---|---|
external_ref | string | The unique attribute associated with the product. This could be an external reference from a separate company system. The unique attribute associated with the product. This could be an external reference from a separate company system, for example. The maximum length is 2048 characters. |
name | string | A name for the product. |
commodity_type | string | The commodity type, either physical or digital. |
components | string | The bundle name, id, type and quantity. |
description | string | A description for the product. |
mpn | string | The manufacturer part number of the product. |
sku | string | The unique stock keeping unit of the product. |
slug | string | A label for the product that is used in the URL paths. A slug can contain any combination of letters, numbers, periods, hyphens, and underscores. NO spaces or other characters are allowed. By default, the product name is used as the slug. |
status | string | The status for the product, either draft or live. |
upc_ean | string | The universal product code or european article number of the product. |
custom_inputs | string | The custom text that can be added to a product. |
The components Object
important
Custom names and values prefixed with $ are not supported.
| Name | Type | Description |
|---|---|---|
name | string | The component name. The component name is the name that is displayed in your storefront. See create a bundle. |
| component_key | string | The component key where component_key is a unique identifier of a component. The bundle_configuration uses the component key to reference a component. A component key should be relatively short and must not contain any special characters. See create a bundle. |
min | integer | The minimum number of product options a shopper can select from this component. |
max | integer | The maximum number of product options a shopper can select from this component. |
name | string | The component name that you want to display in your store front. |
options | array | The product options that make up this component. |
The options Object
| Name | Type | Description |
|---|---|---|
Id | string | The unique Id of the product you want to add to their component. |
Type | integer | Must be product. |
quantity | integer | The number of this product option that a shopper must purchase. |
The locales Object
EP PXM supports localization of products and hierarchies. If your store supports multiple languages, you can localize product names and descriptions. You can have as many locales as you want.
| Name | Type | Description |
|---|---|---|
name | string | A localized name for the product. |
description | string | A localized description for the product. |
The custom_inputs object
| Name | Type | Description |
|---|---|---|
name | string | A name for the custom text field. |
validation_rules | object | The validation rules for the custom text. |
type | string | Must be string. |
options | object | The length of the custom input text field. |
max_length | integer | The number of characters the custom text field can be. You can specify a maximum length up to 255 characters, as the limit is 255 characters. |
required | boolean | true or false depending on whether the custom text is required. |