Get Product Option Value

Retrieve a product option value.

GET/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{id}

Use it in a workflow

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

Request

Path parameters

productIdstringrequired

The id (SKU) of the product.

optionIdstringrequired

The ID of the local product option.

idstringrequired

The ID of the variation attribute to create.

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

Response

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

defaultProductOptionValueboolean

Flag indicating if the product option value is the default value for the product option.

idstring

The ID of the product option value.

optionPricesarray<object>

The list of prices in the product option value.

currencyMnemonicstring

A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.

valuenumber (double)

The amount of money for the given currency.

skuExtensionstring

The SKU extension of the product option value.

valueobject

The localized value of the product option.

json

{
  "id": "5-year",
  "value": {
    "en_US": "5 Year Warranty"
  },
  "defaultProductOptionValue": true,
  "optionPrices": [
    {
      "currencyMnemonic": "USD",
      "value": 1234.56
    }
  ],
  "skuExtension": "extension"
}

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

Was this page helpful?