Create Company Address

Creates an address for a Company account. Use Bulk Create Addresses to create multiple addresses in a single request.

Considerations

In addition to the minimum-required fields presented in the request body example, you may need to supply a stateName or a stateCode if the address is in a designated country.

If you have set one or more address extra fields as mandatory, you must include the extraFields object in the request body. If an extra field is configured to accept only unique values, each fieldValue must be distinct for a successful request.

You can create Company addresses without assigning them as billing or shipping addresses. However, Company users cannot use addresses at checkout without a billing or shipping designation.

Creates an address for a Company account. Use [Bulk Create Addresses](#bulk-create-addresses) to create multiple addresses in a single request. ## Considerations In addition to the minimum-required fields presented in the request body example, you may need to supply a `stateName` or a `stateCode` if the address is in a [designated country](#get-a-state). If you have set one or more address extra fields as mandatory, you must include the `extraFields` object in the request body. If an extra field is configured to accept only unique values, each `fieldValue` must be distinct for a successful request. You can create Company addresses without assigning them as billing or shipping addresses. However, Company users cannot use addresses at checkout without a billing or shipping designation.

Authentication

X-Auth-Tokenstring

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.

Authentication header

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Request

This endpoint expects an object.

firstNamestringOptional

The first name on the address.

lastNamestringOptional

The last name on the address.

phoneNumberstringOptional

The phone number on the address.

zipCodestringOptional

The postal code on the address.

addressLine1stringOptional

The first line of the address.

addressLine2stringOptional

The second line of the address.

citystringOptional

The city on the address.

stateNamestringOptional

The full name of the state or province on the address. This must correspond to stateCode in the request if the state or province is required for the country.

The full name of the state or province on the address. This must correspond to `stateCode` in the request if the state or province is [required for the country](#get-a-state).

countryNamestringOptional

The full name of the country on the address. Use Get a Country to retrieve valid country names.

stateCodestringOptional

The two-letter ISO code for the state or province on the address. Omit this field when adding state or province information for an unsupported country.

countryCodestringOptional

The two-letter ISO code for the country on the address. Use Get a Country to retrieve valid country codes.

companyIdintegerOptional

The unique numeric ID of the Company account.

isBillingbooleanOptional

Indicates whether the address is a billing address.

isShippingbooleanOptional

Indicates whether the address is a shipping address.

isDefaultBillingbooleanOptional

Indicates whether the address is the default billing address.

isDefaultShippingbooleanOptional

Indicates whether the address is the default shipping address.

labelstringOptional

The label used on the storefront to identify the address.

externalIdstringOptional

An external ID assigned to the address in a third-party system, such as an ERP.

extraFieldslist of objectsOptional

Enter extra field information for the address.

Response

codeintegerDefaults to 200

dataobject

metaobject

Errors

422

Unprocessable Entity Error

Creates an address for a Company account. Use Bulk Create Addresses to create multiple addresses in a single request.

Considerations

In addition to the minimum-required fields presented in the request body example, you may need to supply a stateName or a stateCode if the address is in a designated country.

You can create Company addresses without assigning them as billing or shipping addresses. However, Company users cannot use addresses at checkout without a billing or shipping designation.

1	curl -X POST https://api-b2b.bigcommerce.com/api/v3/io/addresses \
2	-H "X-Auth-Token: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"firstName": "Marie",
6	"lastName": "Curie",
7	"phoneNumber": "512-200-1234",
8	"zipCode": "78704",
9	"addressLine1": "512 Bluebonnet Lane",
10	"city": "Austin",
11	"stateName": "Texas",
12	"countryName": "United States",
13	"stateCode": "TX",
14	"countryCode": "US",
15	"companyId": 364336,
16	"isBilling": false,
17	"isShipping": true,
18	"isDefaultBilling": false,
19	"isDefaultShipping": false,
20	"label": "Austin Warehouse",
21	"externalId": "123456",
22	"extraFields": [
23	{
24	"fieldName": "Tax Provider Tax Code",
25	"fieldValue": "G"
26	}
27	],
28	"addressline2": "Building 1"
29	}'

1	{
2	"code": 200,
3	"data": {
4	"addressId": 123456
5	},
6	"meta": {
7	"message": "SUCCESS"
8	}
9	}

Considerations

Authentication

Authentication header

Further reading

Authentication header

Request

Response

Errors

Considerations

Authentication header

Further reading

Authentication header