Storefront Form Fields (Beta)
Read form fields on BigCommerce-hosted storefronts. To work with headless storefronts, use the GraphQL Storefront API.
The REST Storefront API uses CORS (opens in a new tab) headers for authentication, and therefore has no required scopes. You do not need to send any BigCommerce-specific tokens with your requests to these endpoints.
For info about authenticating BigCommerce APIs, see Authentication and Example Requests.
Warning
Breaking changes may be introduced to this endpoint while in beta.
Get Form Fields
GET /form-fields
Request
Gets form fields.
Note
- Substitute your storefront domain for
yourstore.example.com. - The Send a Test Request feature is not currently supported for this endpoint.
Parameters
- store_domain in path - string
- filter in query - array
example
Response
Returns an object with form fields groups.
Body
object | application/json
Group of form field groups
customerAccountarray[object]
List of form fields for the group
shippingAddressarray[object]
List of form fields for the group
billingAddressarray[object]
List of form fields for the group
example
Did you find what you were looking for?