Customization Object


Customizations include options and modifiers which can later be applied to products. Options are designed to add variations to a product, where modifiers add a customizable change to the product but without creating another variant.

Properties
assignedProductsCountintegerRead-onlyformat int32

Number of products this customization is assigned to.

Note: Returned only when you pass "ASSIGNED_PRODUCTS_COUNT" to the fields array in Customizations API requests.


createdDatestringRead-onlyformat date-time

Date and time the customization was created.


customizationRenderTypestringimmutable

Customization render type.

Defines how the customization will be displayed in the storefront.


One Of

choicesSettingsChoicesSettings

Choices settings.

Note: Must be passed along with customizationRenderType of SWATCH_CHOICES and TEXT_CHOICES.


freeTextInputFreeTextSettingsimmutable

Free text input settings.

Note: To be passed along with customizationRenderType: FREE_TEXT.


customizationTypestringimmutable

Customization type.


idstringRead-onlyminLength 1maxLength 36

Customization ID.


keystringRead-onlyminLength 1maxLength 50

A read-only identifier generated from the customization name.

Use key in the catalogReference.options object when integrating Catalog V3 with eCommerce APIs.


namestringminLength 1maxLength 50

Customization name for options (for example, "color", "size") and modifiers (for example, "greeting card").


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the customization is updated. To prevent conflicting changes, the current revision must be passed when updating the customization.

Ignored when creating a customization.


updatedDatestringRead-onlyformat date-time

Date and time the customization was updated.

Did this help?