Sign in

v1

latestSwagger 2.02026-07-17148179252.3 KB
Catalog

Creates a ConfigurableField.

post/catalog/products/{product_id}/configurable-fields

Request body

namestring

The name for the configurable field. Will display on the storefront and can be used as a reference point in the Orders API.

type'text' | 'textarea' | 'checkbox' | 'file' | 'select'

The type of the configurable field, which determines what sort of information the field is intended to collect on the storefront. Supported types in include a text input, a multi-line textarea, a checkbox, a file upload, and a dropdown selection.

file_allowed_typesstring[] nullable

For fields of "file" type, this controls the allowed file types for upload.

file_max_sizeinteger[] nullable

For fields of "file" type, this controls the maximum file size. The platform has a maximum file size of 512MB for all uploads regardless of this setting.

select_optionsstring[] nullable

For fields of "select" type, this is an array of the options which should be presented in the dropdown.

requiredboolean

Controls whether the field is required to have some input before a product may be added to cart.

sort_orderinteger

Controls the sort order of this field relative to other configurable fields on the product, for purposes of ordering them on the storefront.

Response

A ConfigurableField object.

metaMeta

Empty meta object; may be used later.