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

Storefront Customers

Manage customers and data via front-end JavaScript on BigCommerce stencil powered storefronts.

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

For info about authenticating BigCommerce APIs, see Authentication and Example Requests.

Create a Customer

POST /customers

Request

Create a Customer.

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

Data sent the the customer endpoint when creating a customer during checkout.

Body

object | application/json

  • firstName    string

    First name of customer.

  • lastName    string

    Last name of customer.

  • email    string

    Email of customer.

  • password    string

    Password of customer.

  • acceptsMarketingEmails    boolean

    Indicates whether customer provided consent to receive marketing emails.

  • customFields    array[object]

application/json

{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "janedoe@example.com",
  "password": "string",
  "acceptsMarketingEmails": true,
  "customFields": [
    {
      "fieldId": "25",
      "fieldValue": "Leave in backyard"
    }
  ]
}

Response

Customer successfully created.