v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB

CustomField

Update custom field option

Updates the label, value, or display order of an existing option. Requires the stores.products.update permission.

put/stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}

storeIdstring uuid required

The ID of the store.

productIdstring uuid required

The ID of the product.

variantIdstring uuid required

The ID of the variant.

fieldIdstring uuid required

The ID of the parent custom field.

optionIdstring uuid required

The ID of the option to update.

labelstring required

The user-facing label for this option.

valuestring required

The stored value for this option (often same as Label).

orderinteger required

Sort order among sibling options.

The object was successfully updated.

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