Create Variation Attribute

Create a variation attribute.

PUT/organizations/{organizationId}/products/{productId}/variation-attributes/{id}

Use it in a workflow

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

Request

Path parameters

idstringrequired

The ID of the variation attribute to create.

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.

attributeDefinitionIdstringrequired

The id of the requested attribute definition.

attributeDefinitionNameobject

The localized display name of the variation attribute definition.

defaultValuestring

Default variation attribute value.

idstring

The ID of the variation attribute.

nameobject

The localized display name of the variation attribute.

sharedboolean

Returns the value of attribute 'shared' if attribute is local or shared.

slicingboolean

Returns the value of attribute 'slicing'.

valuesarray<object>

The sorted array of variation values. This array can be empty.

descriptionobject

The localized description of the variation value.

imageobject5 fields

Document representing media file.

imageSwatchobject5 fields

Document representing media file.

nameobject

The localized display name of the variation value.

orderableboolean

A flag indicating whether at least one variant with this variation attribute value is available to sell.

positionnumber (double)

The position of the value among all values of a variation attribute.

valuestringrequired

The actual variation value.

variationAttributeTypestring

Variation attribute type.

One ofstringintunknown

json

{
  "attributeDefinitionId": "color",
  "attributeDefinitionName": {
    "en_US": "Color"
  },
  "defaultValue": "black",
  "id": "color",
  "name": {
    "en_US": "Color"
  },
  "shared": false,
  "slicing": true,
  "values": [
    {
      "value": "red",
      "description": {
        "en_US": "Red"
      },
      "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"
        }
      },
      "imageSwatch": {
        "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"
        }
      },
      "name": {
        "color": "Red"
      },
      "orderable": true,
      "position": 2
    }
  ],
  "variationAttributeType": "string"
}

Response

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

attributeDefinitionIdstring

The id of the requested attribute definition.

attributeDefinitionNameobject

The localized display name of the variation attribute definition.

defaultValuestring

Default variation attribute value.

idstring

The ID of the variation attribute.

nameobject

The localized display name of the variation attribute.

sharedboolean

Returns the value of attribute 'shared' if attribute is local or shared.

slicingboolean

Returns the value of attribute 'slicing'.

valuesarray<object>

The sorted array of variation values. This array can be empty.

descriptionobject

The localized description of the variation value.

imageobject5 fields

Document representing media file.

imageSwatchobject5 fields

Document representing media file.

nameobject

The localized display name of the variation value.

orderableboolean

A flag indicating whether at least one variant with this variation attribute value is available to sell.

positionnumber (double)

The position of the value among all values of a variation attribute.

valuestringrequired

The actual variation value.

variationAttributeTypestring

Variation attribute type.

One ofstringintunknown

json

{
  "attributeDefinitionId": "color",
  "attributeDefinitionName": {
    "en_US": "Color"
  },
  "defaultValue": "black",
  "id": "color",
  "name": {
    "en_US": "Color"
  },
  "shared": false,
  "slicing": true,
  "values": [
    {
      "value": "red",
      "description": {
        "en_US": "Red"
      },
      "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"
        }
      },
      "imageSwatch": {
        "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"
        }
      },
      "name": {
        "color": "Red"
      },
      "orderable": true,
      "position": 2
    }
  ],
  "variationAttributeType": "string"
}

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

Was this page helpful?