v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB

CustomField

Create custom field

Adds a new custom field to the specified variant. Options for select/radio fields are managed separately. Requires the stores.products.update permission.

post/stores/{storeId}/products/{productId}/variants/{variantId}/fields

Path parameters

storeIdstring uuid required

The ID of the store containing the product.

productIdstring uuid required

The ID of the product.

variantIdstring uuid required

The ID of the variant to add the field to.

Request body

labelstring required

The display label for this custom field.

identifierstring required

A machine‐friendly identifier (letters, numbers, underscores only).

placeholderstring nullable

Placeholder text shown when the field is empty (text/textarea only).

typestring required

The type of the field. Must be one of the supported types: text, textarea, select, checkbox, radio, number.

isRequiredboolean required

Whether filling out this field is mandatory.

hintstring nullable

Optional help text displayed under the field.

Response

The object was successfully created.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error