post

/customers

Creates a Customers. Multiple customers can be created in one call.

Required Fields

  • last_name
  • first_name
  • email

Required Fields Customer Address

  • first_name
  • city
  • country_code
  • state_or_province
  • last_name
  • address1
  • postal_code

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.

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

2 Headers

Request Body

1 Example
Schema
array[object]
email
string

The email of the customer. Must be unique.

2 validations + required
first_name
string

The first name of the customer.

2 validations + required
last_name
string

The last name of the customer.

2 validations + required
company
string

The company of the customer.

2 validations
phone
string

The phone number of the customer.

2 validations
notes
string

The customer notes.

tax_exempt_category
string

The tax exempt category code for the customer.

2 validations
customer_group_id
integer

Id of the group which this customer belongs to.

1 validation
addresses
array[object]

Array of customer addresses. Limited to 10

1 validation
attributes
array[object]

Array of customer attributes. Limited to 10

1 validation
authentication
object
accepts_product_review_abandoned_cart_emails
boolean

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

store_credit_amounts
array[object]

Store credit.

1 validation

Responses

Customer Response

2 Examples
Schema
object

Response payload for the BigCommerce API.

data
array[object]
meta
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
store_hash
$$.env
2 variables not set
X-Auth-Client
X-Auth-Token