Modifiers

Modifiers help augmenting properties of a variation of a product, price, etc., by creating an array of child products or prices. In each case you specify a modifier type and its value, which define how that property changes the variation option.

See Modifiers for conceptual details.

variations are containers for options which in turn are containers for modifiers.

Modifier types

There's several types of modifiers, and each has a different effect on a property.

Modifier	Data Type	Effect
name_equals	string	Overrides the name of the product with the name specified by the modifier.
name_append	string	Appends the string specified in the modifier to the product's name.
name_prepend	string	Prepends the string specified in the modifier to the product's name.
description_equals	string	Overrides the description of the product.
description_append	string	Appends the string specified in the modifier to the product's description.
description_prepend	string	Prepends the string specified in the modifier to the product's description.
commoditytype	string	Sets the commodity type.
price_increment	price collection	Increases the price of the product.
price_decrement	price collection	Decreases the price of the product.
price_equals	price collection	Sets the price of the product. Cannot be further modified.
slug_equals	string	Sets the slug of the product.
slug_append	string	Appends the string specified in the modifier to the product's slug.
slug_prepend	string	Prepends the string specified in the modifier to the product's slug.
slug_builder	seek/set object	Sets a part of the product's slug.
sku_equals	string	Sets the SKU of the product.
sku_append	string	Appends the string specified in the modifier to the product's SKU.
sku_prepend	string	Prepends the string specified in the modifier to the product's SKU.
sku_builder	seek/set object	Sets a part of the product's SKU.
status	string	Sets the status of the product.

Seek/set modifier type

Using the {SKU} and {SLUG} builder modifiers, you are able to systematically build child products and replace the preconfigured objects with your product variation options. For example, you can set {COLOR} and {SIZE} modifiers and define these in the master product details.

Let's say we set up a variation modifier of 'RED' for {COLOR} and 'MEDIUM' for {SIZE}, a SKU of [BASIC-SHIRT-{SIZE}-{COLOR}] would become [BASIC-SHIRT-MEDIUM-RED].

• For more details how to achieve the same results via the API, see article: Product SKU/Slug Builder Modifiers.

Price modifiers objects

Attributes

Attribute	Type	Description
id	string	The unique identifier for this product
type	string	Represents the type of object (should be modifier)
modifier_type	string	price_increment, price_decrement, price_equals
value.amount	integer	Value of the price modifier
value.currency	string	Currency of this price modifier (3 letter ISO)
value.includes_tax	boolean	true if relevant taxes have been included in the value false if not

Sample Object

{
  "type": "modifier",
  "id": "6d31b2d1-6a26-47e5-9ea0-96b392490ab7",
  "modifier_type": "price_increment",
  "value": [
    {
      "currency": "FJT",
      "amount": 46008803,
      "includes_tax": false
    },
    {
      "currency": "YZK",
      "amount": 4011039,
      "includes_tax": false
    }
  ]
}

SKU/Slug builder modifiers

Attributes

Attribute	Type	Description
id	string	The unique identifier for this product
type	string	Represents the type of object (should be modifier)
modifier_type	string	sku_builder, slug_builder
value.seek	string	A search string for the find / replace
value.set	string	Replacement string

Sample Object

{
  "type": "modifier",
  "id": "6d31b2d1-6a26-47e5-9ea0-96b392490ab7",
  "modifier_type": "sku_builder",
  "value": {
    "seek": "{PLACEHOLDER}",
    "set": "SKU001-",
  }
}

Field override modifiers

Attributes

Attribute	Type	Description
id	string	The unique identifier for this product
type	string	Represents the type of object (should be modifier)
modifier_type	string	description_equals, description_prepend, description_append, commoditytype, name_equals, name_prepend, name_append, slug_equals, slug_prepend, slug_append, sku_equals, sku_prepend, sku_append, status
value	string	A string to be used in place of the product property

Sample Object

{
  "type": "modifier",
  "id": "6d31b2d1-6a26-47e5-9ea0-96b392490ab7",
  "modifier_type": "name_equals",
  "value": "Overrode product name"
}