Create customer extra field

POST https://app.ecwid.com/api/v3/{storeId}/store_extrafields/customers

Required access scopes

Your app must have the following access scopes to make this request: update_customers_extrafields

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

Headers

The Authorization header is required.

Header
Format
Description

Authorization

Bearer secret_ab***cd

Access token of the application.

Request JSON

A JSON object with the following fields:

Field
Type
Description

title

string

Extra field visible at the checkout and in Ecwid admin.

type

string

Extra field type that defines its functionality.

Two values are supported for customer extra fields: text - Single-line text input. Supports placeholders and pre-defined values (default). datetime - Customizable date and time picker in the form of a calendar widget on the checkout.

shownOnOrderDetails

boolean

Defines if the extra field should be visible on the order details page in Ecwid admin.

Response JSON

A JSON object with the following fields:

Field
Type
Description

createCount

number

The number of created items that defines if the request was successful. One of:

1 if the item was created,

0 if the item was not created.

key

string

Internal key (identificator) of the created customer extra field.

Last updated

Was this helpful?