Create Product

Create or overwrite a product with provided data.

PUT/organizations/{organizationId}/products/{productId}

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Create Product action (under Products (Data API)).
Fill in the fields below, then reference the result from later steps as {{createProduct.response.data}}.

Request

Path parameters

productIdstringrequired

The id (SKU) of the product.

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

Request body

Enter the body as JSON in the step's Body field.

assignedCategoriesarray<object>

The catalog categories that the product is assigned to. It is read only.

catalogIdstringrequired

The ID of the catalog.

categoryIdstringrequired

The ID of the category.

atsnumber (double)

The Available To Sell (ATS) inventory value of the product. This is a calculated value.

brandstring

The brand of the product.

bundledProductsarray<object>

The array of bundled products which the product includes. It is read only.

classificationCategoryobject

Document representing a catalog category ID.

catalogIdstringrequired

The ID of the catalog.

categoryIdstringrequired

The ID of the category.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'. It is read only.

defaultVariantIdstring

The ID of the product's default variant. It is read only.

eanstring

The European Article Number of the product.

idstringrequired

The id (SKU) of the product.

imageobject

Document representing media file.

absUrlstring

The absolute URL with request protocol.

altobject

The alternative image text.

disBaseUrlstring

The Dynamic Image Service (DIS) base URL for product images only.

pathstringrequired

The raw media file path.

titleobject

The image title.

imageGroupsarray<object>

The array of product image groups. It is read only.

imagesarray<object>required5 fields

The images of the image group.

variationAttributesarray<object>9 fields

Returns a list of variation attributes applying to this image group.

viewTypestringrequired

The image view type.

inStockboolean

The flag that indicates if the product is in stock, or not. This is a calculated value.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'. It is read only.

localizedTaxClassIdobject

The localized tax class identifier of the product.

longDescriptionobject

The localized long description of the product.

manufacturerNamestring

The name of the product's manufacturer.

manufacturerSkustring

The SKU of the product's manufacturer.

masterobject

Representation of a group of variant products by an attribute. This is a non-buyable entity, provides inheritable attributes for it's product variants, and is used for navigation. *Does'nt have a SKU.*

masterIdstringrequired

The id (SKU) of the product.

orderableboolean

A flag indicating whether at least one of the variants is orderable.

pricenumber (double)

The minimum sales price of the related variants.

priceMaxnumber (double)

The maximum sales of related variants.

pricesobject

prices

nameobject

The localized name of the product.

onlineboolean

The flag that indicates if the product is online, or not. This is a calculated value.

onlineFlagobject

The site-specific online status of the product.

owningCatalogIdstring

The ID of the catalog that owns the product.

owningCatalogNameobject

The localized name of the catalog that owns the product. It is read only.

pageDescriptionobject

The localized page description of the product.

pageKeywordsobject

The localized page keywords of the product.

pageTitleobject

The localized page title of the product.

pricenumber (double)

The price of the product.

priceCurrencystring

The currency code for a product's price.

pricePerUnitnumber (double)

The price per unit of the product. This is a read only field.

primaryCategoriesarray<object>

The primary catalog categories that the product is assigned to. It is read only.

catalogIdstringrequired

The ID of the catalog.

categoryIdstringrequired

The ID of the category.

primaryCategoryIdstring

The ID of the products primary category. This is a read only field. It is read only.

productBundlesarray<object>

The array of product bundles which the product belongs to. It is read only.

productOptionsarray<object>

The array of product options. This is applicable for products of type "option". It is read only.

customNameobject

The localized custom name of the product option.

defaultProductOptionValuestring

The default product option value.

descriptionobject

The localized description of the product option.

idstringrequired

The object attribute definition ID which is also the identifier for the product option.

imageobject5 fields

Document representing media file.

namestring

The name of the object attribute definition.

selectedOptionValuestring

The selected option value of the product option.

sharedboolean

The flag that indicates if the product option is shared or local.

sortingModestring

The sorting mode for the product option values.

One ofbyexplicitorderbyoptionprice

valuesarray<object>5 fields

The sorted array of values of the product option.

productSetsarray<object>

The array of product sets which the product belongs to. It is read only.

searchableobject

The site-specific searchable status of the product.

setProductsarray<object>

The array of set products which the product includes. It is read only.

shortDescriptionobject

The localized short description of the product.

taxClassIdstring

The tax class identifier of the product.

typeobject

Document representing a product type.

bundleboolean

A flag indicating whether the product is a bundle.

bundledboolean

A flag indicating whether the product is bundled.

itemboolean

A flag indicating whether the product is a standard item.

masterbooleanrequired

A flag indicating whether the product is a master.

optionboolean

A flag indicating whether the product is an option.

partOfProductSetboolean

A flag indicating whether the product is part of product set.

partOfRetailSetboolean

A flag indicating whether the product is part of retail set.

retailSetboolean

A flag indicating whether the product is a retail set.

setboolean

A flag indicating whether the product is a set.

variantboolean

A flag indicating whether the product is a variant.

variationGroupboolean

A flag indicating whether the product is a variation group.

unitstring

The sales unit of the product.

json

{
  "id": "apple-ipod-classic",
  "assignedCategories": [
    {
      "catalogId": "apparel-catalog",
      "categoryId": "mens"
    }
  ],
  "ats": 15,
  "brand": "Apple",
  "bundledProducts": [
    {}
  ],
  "classificationCategory": {
    "catalogId": "apparel-catalog",
    "categoryId": "mens"
  },
  "creationDate": 253402214400,
  "defaultVariantId": "apple-ipod-classic-8gb-black",
  "ean": "ksdf69w4",
  "image": {
    "path": "/images/apple-ipod-classic.jpg",
    "absUrl": "https://www.example-image.com/images/apple-ipod-classic.jpg",
    "alt": {
      "en_US": "iPod"
    },
    "disBaseUrl": "https://www.dis-base-url/images/apple-ipod-clasic.jpg",
    "title": {
      "en_US": "iPod"
    }
  },
  "imageGroups": [
    {
      "images": [
        {
          "path": "/images/apple-ipod-classic.jpg",
          "absUrl": "https://www.example-image.com/images/apple-ipod-classic.jpg",
          "alt": {
            "en_US": "iPod"
          },
          "disBaseUrl": "https://www.dis-base-url/images/apple-ipod-clasic.jpg",
          "title": {
            "en_US": "iPod"
          }
        }
      ],
      "viewType": "hi-res",
      "variationAttributes": [
        {
          "attributeDefinitionId": "color",
          "attributeDefinitionName": {
            "en_US": "Color"
          },
          "defaultValue": "black",
          "id": "color",
          "name": {
            "en_US": "Color"
          },
          "shared": false,
          "slicing": true,
          "values": [
            {
              "value": null,
              "description": null,
              "image": null,
              "imageSwatch": null,
              "name": null,
              "orderable": null,
              "position": null
            }
          ],
          "variationAttributeType": "string"
        }
      ]
    }
  ],
  "inStock": true
}

Response

Returns 200 with an object. Read it in later steps with {{createProduct.response.data.<field>}}.

assignedCategoriesarray<object>

The catalog categories that the product is assigned to. It is read only.

catalogIdstringrequired

The ID of the catalog.

categoryIdstringrequired

The ID of the category.

atsnumber (double)

The Available To Sell (ATS) inventory value of the product. This is a calculated value.

brandstring

The brand of the product.

bundledProductsarray<object>

The array of bundled products which the product includes. It is read only.

classificationCategoryobject

Document representing a catalog category ID.

catalogIdstringrequired

The ID of the catalog.

categoryIdstringrequired

The ID of the category.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'. It is read only.

defaultVariantIdstring

The ID of the product's default variant. It is read only.

eanstring

The European Article Number of the product.

idstring

The id (SKU) of the product.

imageobject

Document representing media file.

absUrlstring

The absolute URL with request protocol.

altobject

The alternative image text.

disBaseUrlstring

The Dynamic Image Service (DIS) base URL for product images only.

pathstringrequired

The raw media file path.

titleobject

The image title.

imageGroupsarray<object>

The array of product image groups. It is read only.

imagesarray<object>required5 fields

The images of the image group.

variationAttributesarray<object>9 fields

Returns a list of variation attributes applying to this image group.

viewTypestringrequired

The image view type.

inStockboolean

The flag that indicates if the product is in stock, or not. This is a calculated value.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'. It is read only.

localizedTaxClassIdobject

The localized tax class identifier of the product.

longDescriptionobject

The localized long description of the product.

manufacturerNamestring

The name of the product's manufacturer.

manufacturerSkustring

The SKU of the product's manufacturer.

masterobject

masterIdstringrequired

The id (SKU) of the product.

orderableboolean

A flag indicating whether at least one of the variants is orderable.

pricenumber (double)

The minimum sales price of the related variants.

priceMaxnumber (double)

The maximum sales of related variants.

pricesobject

prices

nameobject

The localized name of the product.

onlineboolean

The flag that indicates if the product is online, or not. This is a calculated value.

onlineFlagobject

The site-specific online status of the product.

owningCatalogIdstring

The ID of the catalog that owns the product.

owningCatalogNameobject

The localized name of the catalog that owns the product. It is read only.

pageDescriptionobject

The localized page description of the product.

pageKeywordsobject

The localized page keywords of the product.

pageTitleobject

The localized page title of the product.

pricenumber (double)

The price of the product.

priceCurrencystring

The currency code for a product's price.

pricePerUnitnumber (double)

The price per unit of the product. This is a read only field.

primaryCategoriesarray<object>

The primary catalog categories that the product is assigned to. It is read only.

catalogIdstringrequired

The ID of the catalog.

categoryIdstringrequired

The ID of the category.

primaryCategoryIdstring

The ID of the products primary category. This is a read only field. It is read only.

productBundlesarray<object>

The array of product bundles which the product belongs to. It is read only.

productOptionsarray<object>

The array of product options. This is applicable for products of type "option". It is read only.

customNameobject

The localized custom name of the product option.

defaultProductOptionValuestring

The default product option value.

descriptionobject

The localized description of the product option.

idstringrequired

The object attribute definition ID which is also the identifier for the product option.

imageobject5 fields

Document representing media file.

namestring

The name of the object attribute definition.

selectedOptionValuestring

The selected option value of the product option.

sharedboolean

The flag that indicates if the product option is shared or local.

sortingModestring

The sorting mode for the product option values.

One ofbyexplicitorderbyoptionprice

valuesarray<object>5 fields

The sorted array of values of the product option.

productSetsarray<object>

The array of product sets which the product belongs to. It is read only.

searchableobject

The site-specific searchable status of the product.

setProductsarray<object>

The array of set products which the product includes. It is read only.

shortDescriptionobject

The localized short description of the product.

taxClassIdstring

The tax class identifier of the product.

typeobject

Document representing a product type.

bundleboolean

A flag indicating whether the product is a bundle.

bundledboolean

A flag indicating whether the product is bundled.

itemboolean

A flag indicating whether the product is a standard item.

masterbooleanrequired

A flag indicating whether the product is a master.

optionboolean

A flag indicating whether the product is an option.

partOfProductSetboolean

A flag indicating whether the product is part of product set.

partOfRetailSetboolean

A flag indicating whether the product is part of retail set.

retailSetboolean

A flag indicating whether the product is a retail set.

setboolean

A flag indicating whether the product is a set.

variantboolean

A flag indicating whether the product is a variant.

variationGroupboolean

A flag indicating whether the product is a variation group.

unitstring

The sales unit of the product.

json

{
  "id": "apple-ipod-classic",
  "assignedCategories": [
    {
      "catalogId": "apparel-catalog",
      "categoryId": "mens"
    }
  ],
  "ats": 15,
  "brand": "Apple",
  "bundledProducts": [
    {}
  ],
  "classificationCategory": {
    "catalogId": "apparel-catalog",
    "categoryId": "mens"
  },
  "creationDate": 253402214400,
  "defaultVariantId": "apple-ipod-classic-8gb-black",
  "ean": "ksdf69w4",
  "image": {
    "path": "/images/apple-ipod-classic.jpg",
    "absUrl": "https://www.example-image.com/images/apple-ipod-classic.jpg",
    "alt": {
      "en_US": "iPod"
    },
    "disBaseUrl": "https://www.dis-base-url/images/apple-ipod-clasic.jpg",
    "title": {
      "en_US": "iPod"
    }
  },
  "imageGroups": [
    {
      "images": [
        {
          "path": "/images/apple-ipod-classic.jpg",
          "absUrl": "https://www.example-image.com/images/apple-ipod-classic.jpg",
          "alt": {
            "en_US": "iPod"
          },
          "disBaseUrl": "https://www.dis-base-url/images/apple-ipod-clasic.jpg",
          "title": {
            "en_US": "iPod"
          }
        }
      ],
      "viewType": "hi-res",
      "variationAttributes": [
        {
          "attributeDefinitionId": "color",
          "attributeDefinitionName": {
            "en_US": "Color"
          },
          "defaultValue": "black",
          "id": "color",
          "name": {
            "en_US": "Color"
          },
          "shared": false,
          "slicing": true,
          "values": [
            {
              "value": null,
              "description": null,
              "image": null,
              "imageSwatch": null,
              "name": null,
              "orderable": null,
              "position": null
            }
          ],
          "variationAttributeType": "string"
        }
      ]
    }
  ],
  "inStock": true
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?