Skip to main content

Create a modifier

POST 

https://euwest.api.elasticpath.com/pcm/variations/:variationID/options/:optionID/modifiers

You can specify different modifiers for different options in a variation. When you build child products using options in variations, the properties of a child products depends on the modifier set for the options that are applied to the child product.

The table below describes the different types of modifiers.

ModifierData TypeEffect
name_equalsstringOverrides the name of the child product with the name specified by the modifier.
name_appendstringAppends the string specified in the modifier to the name of the child product.
name_prependstringPrepends the string specified in the modifier to the name of the child product.
description_equalsstringOverrides the description of the child product.
description_appendstringAppends the string specified in the modifier to the description of the child product.
description_prependstringPrepends the string specified in the modifier to the product description of the child product.
commodity_typestringSets the commodity type of the child product, such as physical or digital.
pricestringAllows application of price modifiers (price_increment, price_decrement, and price_equals) to the child products.
price_incrementstringIncreases the price of the child product.
price_decrementstringDecreases the price of the child product.
price_equalsstringSets the price of a child product to the amount you specify.
slug_appendstringAppends the string specified in the modifier to the slug of the child product. Can only contain A-Z, a-z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. However, for the slug-builder modifier, you can use {} in the seek field, for example, "seek": :{COLOR}".
slug_prependstringPrepends the string specified in the modifier to the slug of the child product. Can only contain A-Z, a-z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. However, for the slug-builder modifier, you can use {} in the seek field, for example, "seek": :{COLOR}".
slug_builderstringSets a part of the slug of the child product. Can only contain A-Z, a-z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. However, for the slug-builder modifier, you can use {} in the seek field, for example, "seek": :{COLOR}".
sku_equalsstringSets the SKU of the child product.
sku_appendstringAppends the string specified in the modifier to the SKU of the child product.
sku_prependstringPrepends the string specified in the modifier to the SKU of the child product.
sku_builderstringSets a part of the SKU of the child product.
statusstringSets the status of the child product, such as draft or live.

Request

Responses

Successfully returns the created modifier

Authorization: http

name: bearerAuthtype: httpscheme: bearer

Request Collapse all
Base URL
https://euwest.api.elasticpath.com
Auth
Parameters
— pathrequired
— pathrequired
Body
{
  "data": {
    "type": "product-variation-modifier",
    "attributes": {
      "type": "commodity_type",
      "value": "string",
      "seek": "string",
      "set": "string",
      "reference_name": "string"
    }
  }
}
ResponseClear

Click the Send API Request button above and see the response here!

We use cookies to enhance your experience. By continuing to visit this site you agree to our use of cookies.