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
idstringRead-onlyminLength 1maxLength 36

Customization ID.


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


createdDatestringRead-onlyformat date-time

Date and time the customization was created.


updatedDatestringRead-onlyformat date-time

Date and time the customization was updated.


namestringminLength 1maxLength 50

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


customizationTypestring
3 enum supported values:
UNKNOWN_CUSTOMIZATION_TYPEPRODUCT_OPTIONMODIFIER

Customization type.


customizationRenderTypestring
4 enum supported values:
UNKNOWN_CUSTOMIZATION_RENDER_TYPEFREE_TEXTTEXT_CHOICESSWATCH_CHOICES

Customization render type.

Defines how the customization will be displayed in the storefront.


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.


ONE OF:


freeTextInputobject

Free text input settings.

Note: To be passed along with customizationRenderType: FREE_TEXT.


choicesSettingsobject

Choices settings.

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

Was this helpful?
Yes
No