Custom Fields
Get Custom Fields
Retrieves the custom fields.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerCreate Custom Field
Creates a new custom field.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/json
Requiredname
RequiredstringMust not be greater than 255 characters.
placeholder
stringMust not be greater than 255 characters.
hint
stringMust not be greater than 255 characters.
type
Requiredstring"text" | "textarea" | "checkbox" | "select"
options
stringMust not be greater than 255 characters.
default
stringMust not be greater than 255 characters.
regex
stringMust not be greater than 255 characters.
is_required
booleanPath Parameters
shopId
RequiredintegerDelete Custom Field
Deletes a custom field.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegercustomFieldId
RequiredstringUpdate Custom Field
Updates an existing custom field.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/json
Requiredname
RequiredstringMust not be greater than 255 characters.
placeholder
stringMust not be greater than 255 characters.
hint
stringMust not be greater than 255 characters.
type
Requiredstring"text" | "textarea" | "checkbox" | "select"
options
stringMust not be greater than 255 characters.
default
stringMust not be greater than 255 characters.
regex
stringMust not be greater than 255 characters.
is_required
booleanPath Parameters
shopId
RequiredintegercustomFieldId
Requiredstring