Creates a Customer Address. Multiple customer addresses can be created in one call.
Required Fields
customer_id
first_name
last_name
city
country_code
address1
state_or_province
postal_code
Notes
A unique customer address is a combination of the following core address fields:
customer_id
first_name
last_name
company
phone
address_type
address1
address2
city
country_code
state_or_province
postal_code
An attempt to create an address that already exists will result in no change to the address or custom form field values, an HTTP 200 return code, and the address will be absent from the response body.
The default rate limit for this endpoint is 10 concurrent requests.
Authentication
X-Auth-Token in header
Parameters
store_hash in path - string
Accept in header with default of application/json - string
Content-Type in header with default of application/json - string
Body
array | application/json
first_namestring
required
The first name of the customer address.
>= 1 characters<= 255 characters
Example: John
last_namestring
required
The last name of the customer address.
>= 1 characters<= 255 characters
Example: Doe
companystring
The company of the customer address.
>= 0 characters<= 255 characters
Example: BigCommerce
address1string
required
The address 1 line.
Example: 123 Example Street
address2string
The address 2 line.
Example: Building 4
citystring
required
The city of the customer address.
>= 0 characters<= 100 characters
Example: Austin
state_or_provincestring
required
The state or province name spelled out in full. It is required for countries that need a state/province to complete an address. State or province codes not accepted.
>= 0 characters<= 100 characters
Example: Texas
postal_codestring
required
The postal code of the customer address. It is required for countries that need postal codes to complete an address.
Updates a Customer Address. Multiple customer addresses can be updated in one call.
Required Fields
id -- ID of the Customer Address
Limits
Limit of 3 concurrent requests.
Notes
A unique customer address is a combination of the following core address fields:
first_name
last_name
company
phone
address_type
address1
address2
city
country_code
state_or_province
postal_code
An attempt to update an address such that it becomes identical to another address that already exists will result in no change to the target address or custom form field values. The response will have an HTTP 200 return code, and the address will be absent from the response body.
Authentication
X-Auth-Token in headerAuthentication details
Parameters
store_hash in path - string
Accept in header with default of application/json - string
Content-Type in header with default of application/json - string
Body
array | application/json
first_namestring
The first name of the customer address.
>= 1 characters<= 255 characters
last_namestring
The last name of the customer address.
>= 1 characters<= 255 characters
companystring
The company of the customer address.
>= 0 characters<= 255 characters
address1string
The address 1 line.
address2string
The address 2 line.
citystring
The city of the customer address.
>= 0 characters<= 100 characters
state_or_provincestring
The state or province name.
>= 0 characters<= 100 characters
Example: California
postal_codestring
The postal code of the customer address.
>= 0 characters<= 30 characters
country_codestring
The country code of the customer address.
>= 2 characters<= 2 characters
Example: US
phonestring
The phone number of the customer address.
>= 0 characters<= 50 characters
address_typestring
The address type. Residential or Commercial.
Allowed: residential | commercial
Example: residential
idinteger
required
The unique numeric ID of the address.
Example: 1
form_fieldsarray[object]
Array of form fields. Controlled by formfields parameter.
example-1
JSONcURLNode.jsPHPJava
99
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
›
[
{
"id": 11,
"first_name": "John",
"last_name": "Doe",
"address1": "111 E West Street",
"address2": "654",
"city": "Akron",
"state_or_province": "Ohio",
"postal_code": "44325",
"country_code": "US",
"phone": "1234567890",
"address_type": "residential",
"form_fields": [
{
"name": "test",
"value": "test"
}
]
}
]
example-2-form-fields
JSONcURLNode.jsPHPJava
99
1
2
3
4
5
6
7
8
9
10
11
›
[
{
"id": 11,
"form_fields": [
{
"name": "test",
"value": "test"
}
]
}
]
Response
200422
Body
object | application/json
Any of:AddressCollectionResponseDuplicateAddressCollectionResponse