Customers V3
Get Customer Form Field Values
GET /stores/{store_hash}/v3/customers/form-field-values
Request
Returns a list of form field values for the Customer or Customer Address object.
To learn about adding and managing form fields, see Adding and Editing Fields in the Account Signup Form.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string
- Content-Type in header with default of application/json - string
- page in query - integer
Page number.
page=1
- limit in query - number
Items count per page.
limit=50
- customer_id in query - integer
Filter by the customer ID.
- address_id in query - integer
Filter by the ID of the customer address.
- field_name in query - string
Filter by the field name.
- field_type in query - string
Filter by the field type.
checkboxes
- checkboxes fielddate
- date fieldmultiline
- multiline text fieldnumbers
- numbers only fieldpassword
- password fieldradiobuttons
- radio buttons fieldtext
- text fieldpicklist
- pick list field
Allowed values: checkboxes | date | multiline | numbers | password | radiobuttons | text | picklist
example
Response
Body
dataarray[]
metaobject
Data about the response, including pagination and collection totals.
Customer and Customer Address Form Fields example
Customer Form Fields example
Customer Address Form Fields example
Upsert Customer Form Field Values
PUT /stores/{store_hash}/v3/customers/form-field-values
Request
Updates form field values on the Customer or Customer Address objects. Multiple form field values can be updated in one call.
Upsert checks for an existing record, if there is none it creates the record, if there is a matching record it updates that record.
To learn more about editing form fields, see Adding and Editing Fields in the Account Signup Form.
Limits
- Limit of 10 concurrent requests.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
Body
namestring
requiredThe form field name.
Example: color
value
requiredOne of:string number array Example: blue
customer_idinteger
required
Example
Response
Body
dataarray[] metaobject
Response metadata.