Customizations

Fields

idstringUnique identifier of the resource.

namestringName shown to buyers; unique in the store when internalName is not set.

statusenumGroup status; inactive groups are not offered to buyers.active · inactive

internalNamestringName only staff see; unique in the store. Null when not set.

descriptionstringGroup description; null when not set.

selectionTypeenumsingle allows one option, multiple several, and text a line the buyer types.single · multiple · text

displayenumHow options are shown: list, color, image or font.list · color · image · font

isRequiredbooleanWhether a customized cart line must include this group.

See all 17 fields

minSelectionsintegerMinimum number of options to choose.

maxSelectionsintegerMaximum number of options to choose; null means no limit.

maxLengthintegerMaximum characters a buyer can type in a text group; null for other types.

priceDeltanumberAmount a text group adds per unit, in the store currency; 0 for other types.

orderintegerPosition in the store order, which products also follow.

optionsarray<object>Options in the group, sorted by order; empty for text groups.

productCountintegerNumber of products, not deleted, that use the customization.

createdOnstringTimestamp when the resource was created, in ISO 8601.

updatedOnstringTimestamp when the resource was last modified, in ISO 8601.