Get Variation For Master Product

Get details of a specific variation.

GET/organizations/{organizationId}/products/{masterProductId}/variations/{id}

Use it in a workflow

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

Request

Path parameters

idstringrequired

The ID of the variation attribute to create.

masterProductIdstringrequired

The ID of the master product that contains the variation group.

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).

Query parameters

siteIdstring

The site context.

Response

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

atsnumber (double)

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

defaultProductVariationboolean

A flag indicating whether the variant is a default variant.

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.

inStockboolean

True if the product is in stock, false if not.

onlineboolean

If the product is currently online. True if online, false if not.

orderableboolean

A flag indicating whether the variant is orderable.

pricenumber (double)

The sales price of the variant.

priceCurrencystring

Currency code for the price of the product.

productIdstring

The id (SKU) of the product.

searchableobject

A flag indicating whether the variant is searchable.

variationAttributesarray<object>

Variation attributes.

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>7 fields

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

variationAttributeTypestring

Variation attribute type.

One ofstringintunknown

variationValuesobject

The actual variation attribute ID - value pairs.

json

{
  "productId": "apple-ipod-classic",
  "ats": 10,
  "defaultProductVariation": true,
  "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"
    }
  },
  "inStock": true,
  "online": true,
  "orderable": true,
  "price": 29.99,
  "priceCurrency": "USD",
  "searchable": {
    "Site1": true
  },
  "variationAttributes": [
    {
      "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"
    }
  ],
  "variationValues": {
    "color": "black"
  }
}

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

Was this page helpful?