Docs
Storefront API
Customers

Storefront Customers

Manage customers and data 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.

When reCAPTCHA is enabled on the store, use the token field in the request body. Ensure that you use a valid user verification response reCAPTCHA token.

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.

  • password    string

    Password of customer.

  • acceptsMarketingEmails    boolean

    Indicates whether customer provided consent to receive marketing emails.

  • token    string

    A valid reCAPTCHA token from a successful verification response.

  • 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.

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Set Cookie Consent PreferencesCreate a Customer