v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB

CustomField

Delete custom field

Removes the specified custom field and all its options from the variant. Requires the stores.products.update permission.

delete/stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}

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 containing the field.

fieldIdstring uuid required

The ID of the custom field to delete.

Response

The object was successfully deleted.

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

{"stackTrail":"components:schemas:ObjectResponse:properties:data","oasType":"schema","type":"unknown","description":"Represents the data associated with a response.","nullable":true}