Docs
Storefront API
Form fields

Storefront Form Fields

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.

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
    Type: array[string]

    Allowed: customerAccount | shippingAddress | billingAddress

example

Response

Returns an object with form fields groups.

Body

object | application/json
Group of form field groups

  • customerAccount    array[object]

    List of form fields for the group

  • shippingAddress    array[object]

    List of form fields for the group

  • billingAddress    array[object]

    List of form fields for the group

example

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Create a SubscriptionGet Form Fields