Custom Fields
Get Custom Fields
Retrieves the custom fields.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerCreate Custom Field
Creates a new custom field.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequirednameRequiredstringMust not be greater than 255 characters.
placeholderstringMust not be greater than 255 characters.
hintstringMust not be greater than 255 characters.
typeRequiredstring"text" | "textarea" | "checkbox" | "select"optionsstringMust not be greater than 255 characters.
defaultstringMust not be greater than 255 characters.
regexstringMust not be greater than 255 characters.
is_requiredbooleanPath Parameters
shopIdRequiredintegerDelete Custom Field
Deletes a custom field.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegercustomFieldIdRequiredstringUpdate Custom Field
Updates an existing custom field.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequirednameRequiredstringMust not be greater than 255 characters.
placeholderstringMust not be greater than 255 characters.
hintstringMust not be greater than 255 characters.
typeRequiredstring"text" | "textarea" | "checkbox" | "select"optionsstringMust not be greater than 255 characters.
defaultstringMust not be greater than 255 characters.
regexstringMust not be greater than 255 characters.
is_requiredbooleanPath Parameters
shopIdRequiredintegercustomFieldIdRequiredstring