Thanks for being patient while we implement your feedback to improve the developer experience.

Storefront Form Fields (Beta)

Read form fields on a BigCommerce hosted storefront.

For info about API accounts, see our Guide to API Accounts.

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 - string

example

const options = {method: 'GET', headers: {'Content-Type': 'application/json'}};

fetch('https://yourstore.example.com/api/storefront/form-fields', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

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

{
  "customerAccount": [
    {
      "id": "string",
      "name": "string",
      "custom": true,
      "label": "string",
      "required": true,
      "default": "string",
      "type": "integer",
      "fieldType": "checkbox",
      "min": "string",
      "max": "string",
      "maxLength": 0,
      "secret": true,
      "options": {
        "helperLabel": "string",
        "items": [
          {
            "label": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "shippingAddress": [
    {
      "id": "string",
      "name": "string",
      "custom": true,
      "label": "string",
      "required": true,
      "default": "string",
      "type": "integer",
      "fieldType": "checkbox",
      "min": "string",
      "max": "string",
      "maxLength": 0,
      "secret": true,
      "options": {
        "helperLabel": "string",
        "items": [
          {
            "label": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "billingAddress": [
    {
      "id": "string",
      "name": "string",
      "custom": true,
      "label": "string",
      "required": true,
      "default": "string",
      "type": "integer",
      "fieldType": "checkbox",
      "min": "string",
      "max": "string",
      "maxLength": 0,
      "secret": true,
      "options": {
        "helperLabel": "string",
        "items": [
          {
            "label": "string",
            "value": "string"
          }
        ]
      }
    }
  ]
}