BigCommerce Docs

curl -X POST https://api-b2b.bigcommerce.com/api/v2/companies/123/addresses \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "firstName": "Marie",
  "addressLine1": "512 Bluebonnet Lane",
  "city": "Austin",
  "country": {
    "countryName": "United States",
    "countryCode": "US"
  },
  "isShipping": "1",
  "isBilling": "0",
  "phoneNumber": "8001234567",
  "addressLine2": "Building 2",
  "zipCode": "78726",
  "state": {
    "stateName": "Texas",
    "stateCode": "TX"
  },
  "isDefaultShipping": "0",
  "isDefaultBilling": "0",
  "label": "Austin Warehouse",
  "extraFields": [
    {
      "fieldName": "Company Tax Code",
      "fieldValue": "Code G"
    }
  ]
}'

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

The unique numeric ID of the Company account.

Request

Extra Field Values

firstNamestringRequired

The first name of the address.

addressLine1stringRequired

The first line of the address

citystringRequired

City of the address.

countryobjectRequired

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

isShippingstringOptional

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

isBillingstringOptional

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

phoneNumberstringOptional

The phone number associated with the address.

addressLine2stringOptional

The second line of the address

zipCodestringOptional

Zip or Postal Code of the address.

stateobjectOptional

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

isDefaultShippingstringOptional

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

isDefaultBillingstringOptional

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

labelstringOptional

The label used on the storefront to identify the address.

extraFieldslist of objectsOptional

Response

messagestring

codedoubleDefaults to 200

dataobject

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