API Reference

Create a custom field

post
https://api.ecommerceapi.uk/v1/custom-fields

Creates a new custom field. The custom fields app is installed automatically if not already installed.

Body Params
string
required

Name of the custom field (max 40 characters, only letters, digits, and underscores).

string
Defaults to text

Type of the custom field. Defaults to 'text'. Valid values: text, toggle, choice, list, date, date_time, value_list, product_list.

string

Label of the custom field.

string
required

Item type associated with the custom field. Valid values: product, category, brand, order, page, blog_post.

integer

The display order of the custom field.

allowedValues
array of strings

Allowed values for value_list (max 20 values), only for choice and list types.

allowedValues
Responses

400

Invalid request data.

401

Unauthorized. Invalid or missing API key.

500

Server error.

Updated 6 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago