Create Customers | BigCommerce Developer Center

Creates Customers. Create up to 10 customers in one call.

Required Fields

last_name
first_name
email

Required Fields Customer Address

first_name
city
country_code
last_name
address1

Required Fields Attributes

Attributes must be created BEFORE creating a customer.
attribute_id
attribute_value — This is input as a string, regardless of the Type.

Notes

A customer can be created with global access or channel-specific access.

Global access:
- Make sure the channel has allow_global_logins enabled. This is on by default only for the default storefront. Find more info at Customer Settings > Channel.
- Omit channel_ids field, or provide channel_ids: null.
Channel-specific access:
- Provide a channel_ids array containing the channels accessible by the customer. This array cannot be empty.

Creates Customers. Create up to 10 customers in one call. **Required Fields** * last_name * first_name * email **Required Fields Customer Address** * first_name * city * country_code * last_name * address1 **Required Fields Attributes** * Attributes must be [created](/developer/api-reference/rest/admin/management/customers/v3/attributes#create-a-customer-attribute) **BEFORE** creating a customer. * attribute_id * attribute_value -- This is input as a string, regardless of the [Type](/developer/api-reference/rest/admin/management/customers/v3/attributes#create-a-customer-attribute). **Notes** A customer can be created with global access or channel-specific access. * **Global access:** * Make sure the channel has `allow_global_logins` enabled. This is on by default only for the default storefront. Find more info at [Customer Settings > Channel](/developer/api-reference/rest/admin/management/customers/v3/channel-settings). * Omit `channel_ids` field, or provide `channel_ids: null`. * **Channel-specific access:** * Provide a `channel_ids` array containing the channels accessible by the customer. This array cannot be empty.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`
Stored Payment Instruments	modify	`store_stored_payment_instruments`
Stored Payment Instruments	read-only	`store_stored_payment_instruments_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Customers | modify | `store_v2_customers` | | Customers | read-only | `store_v2_customers_read_only` | | Stored Payment Instruments | modify | `store_stored_payment_instruments` | | Stored Payment Instruments | read-only | `store_stored_payment_instruments_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

emailstringRequired3-250 characters

The email of the customer. Must be unique.

first_namestringRequired1-100 characters

The first name of the customer.

last_namestringRequired1-100 characters

The last name of the customer.

companystringOptional0-255 characters

The company of the customer.

phonestringOptional0-50 characters

The phone number of the customer.

notesstringOptional

The customer notes.

tax_exempt_categorystringOptional0-255 characters

The tax exempt category code for the customer.

customer_group_idintegerOptional

ID of the group which this customer belongs to.

addresseslist of objectsOptional

Array of customer addresses. Limited to 10.

attributeslist of objectsOptional

Array of customer attributes. Limited to 10.

authenticationobjectOptional

accepts_product_review_abandoned_cart_emailsbooleanOptional

It determines if the customer is signed up to receive either product review or abandoned cart emails or receive both emails.

store_credit_amountslist of objectsOptional

Store credit.

origin_channel_idintegerOptional

Channel ID of the customer that has created the form.

channel_idslist of integersOptional

Array of channels the customer can access.

form_fieldslist of objectsOptional

Array of form fields. Controlled by formfields parameter.

trigger_account_created_notificationbooleanOptional

Indicates whether to send a customer registered welcome email.

Response

Customer Collection Response

datalist of objects

metaobject

Response metadata.

Errors

413

Content Too Large Error

422

Unprocessable Entity Error

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`
Stored Payment Instruments	modify	`store_stored_payment_instruments`
Stored Payment Instruments	read-only	`store_stored_payment_instruments_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

1	curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/customers \
2	-H "X-Auth-Token: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"email": "string@example.com",
7	"first_name": "string",
8	"last_name": "string",
9	"company": "string",
10	"phone": "string",
11	"notes": "string",
12	"tax_exempt_category": "string",
13	"customer_group_id": 0,
14	"addresses": [
15	{
16	"first_name": "Ronald",
17	"last_name": "Swimmer",
18	"address1": "Addr 1",
19	"city": "San Francisco",
20	"country_code": "US",
21	"company": "History",
22	"address2": "",
23	"state_or_province": "California",
24	"postal_code": "33333",
25	"phone": "707070707",
26	"address_type": "residential",
27	"form_fields": [
28	{
29	"name": "test",
30	"value": "test"
31	}
32	]
33	}
34	],
35	"authentication": {
36	"force_password_reset": true,
37	"new_password": "string123"
38	},
39	"accepts_product_review_abandoned_cart_emails": true,
40	"store_credit_amounts": [
41	{
42	"amount": 43.15
43	}
44	],
45	"origin_channel_id": 1,
46	"channel_ids": [
47	1
48	],
49	"form_fields": [
50	{
51	"name": "test",
52	"value": "test"
53	}
54	],
55	"trigger_account_created_notification": true
56	}
57	]'

1	{
2	"data": [
3	{
4	"email": "string@example.com",
5	"first_name": "string",
6	"last_name": "string",
7	"company": "string",
8	"phone": "string",
9	"notes": "string",
10	"tax_exempt_category": "string",
11	"customer_group_id": 0,
12	"addresses": [
13	{
14	"first_name": "string",
15	"last_name": "string",
16	"address1": "Addr1",
17	"city": "string",
18	"state_or_province": "string",
19	"postal_code": "string",
20	"country_code": "st",
21	"customer_id": 0,
22	"id": 0,
23	"address2": "",
24	"phone": "string",
25	"address_type": "residential",
26	"country": "string"
27	}
28	],
29	"store_credit_amounts": [
30	{
31	"amount": 43.15
32	}
33	],
34	"accepts_product_review_abandoned_cart_emails": true,
35	"channel_ids": [
36	null
37	],
38	"shopper_profile_id": "82511e54-4040-40fe-b742-2b25655f205b",
39	"segment_ids": [
40	"5bb733a9-5491-47b3-9451-9ae8d6a6bc6b"
41	]
42	}
43	],
44	"meta": {}
45	}