BigCommerce Docs

Creates an address for a Company account, if address book management is enabled for your storefront. You can designate whether the address is for shipping, billing, or both.

Equivalent Storefront GraphQL API Mutation: addressCreate. For more information, see the GraphQL Playground.

Creates an address for a Company account, if address book management is enabled for your storefront. You can designate whether the address is for shipping, billing, or both. Equivalent Storefront GraphQL API Mutation: `addressCreate`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).

Authentication

AuthorizationBearer

Authentication header

Header	Argument	Description
`Authorization`	`Bearer {{B2B_JWT_TOKEN}}`	You can obtain this token using the steps described in the REST Storefront API section[…]

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api) section[...]

Path parameters

companyIdstringRequired

Request

This endpoint expects an object.

countryobjectOptional

Country of the address as an object with both the name and the two-character code.

extraFieldslist of objectsOptional

firstNamestringOptional

The first name of the address.

isBillingstringOptional

Indicates whether the address can be used as a billing address.

isDefaultBillingstringOptional

Indicates whether the address is the default billing address for the Company account.

isDefaultShippingstringOptional

Indicates whether the address is the default shipping address for the Company account.

isShippingstringOptional

Indicates whether the address can be used as a shipping address.

labelstringOptional

The label used on the storefront to identify the address.

phoneNumberstringOptional

The phone number associated with the address.

stateobjectOptional

State of the address as an object with both the name and the two-character code.

Response

messagestring

codedoubleDefaults to 200

dataobject

1	curl -X POST https://api-b2b.bigcommerce.com/api/v2/companies/companyId/addresses \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"country": {
6	"countryName": "United States",
7	"countryCode": "US"
8	},
9	"extraFields": [
10	{
11	"fieldName": "Company Tax Code",
12	"fieldValue": "Code G"
13	}
14	],
15	"firstName": "Marie",
16	"isBilling": "0",
17	"isDefaultBilling": "0",
18	"isDefaultShipping": "0",
19	"isShipping": "1",
20	"label": "Austin Warehouse",
21	"phoneNumber": "8001234567",
22	"state": {
23	"stateName": "Texas",
24	"stateCode": "TX"
25	},
26	"addressLine1": "512 Bluebonnet Lane",
27	"addressLine2": "Building 2",
28	"city": "Austin",
29	"zipCode": "78726"
30	}'

1	{
2	"message": "string",
3	"code": 200,
4	"data": {
5	"addressId": "27"
6	}
7	}