Create a product customisation field

Creates a new product customisation field.

post/products/{product_id}/customization-fields

Request

  • Base URL
    https://api.ecommerceapi.uk/v1
  • URL
    https://api.ecommerceapi.uk/v1/products/{product_id}/customization-fields
  • Auth
    HTTP basic

Path parameters

product_idinteger required

ID of the product which the customisation field will be assigned to.

Request body

labelstring required

The field label.

type1 | 2 required

The type of customisation field (1 for text input, 2 for text area).

max_lengthinteger

The maximum allowed length for the customisation field. Defaults to 0 (no limit).

Response

Product customisation field created successfully.

idinteger

Unique identifier for the customisation field.

labelstring

The label of the customisation field.

type1 | 2

The type of the customisation field (1 for text input, 2 for text area).

max_lengthinteger

The maximum allowed length for the customisation field. Defaults to 0 (no limit).

Changes

No recorded changes to this operation across all 1 revision of this API.