For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
- Download OpenAPI Specs
REST
GraphQL
MCP
Resources

GraphQL Storefront Types Objects

CustomerAddress

OBJECT

Definition

1 type CustomerAddress {
2   entityId: Int!
3   firstName: String!
4   lastName: String!
5   address1: String!
6   address2: String
7   addressType: DestinationAddressType
8   city: String!
9   country: String
10   countryId: Int
11   countryCode: String!
12   stateOrProvince: String
13   stateId: Int
14   phone: String
15   postalCode: String
16   company: String
17   formFields: [CustomerFormFieldValue!]!
18 }

Address that is associated with a customer account.

Was this page helpful?

CustomerAccessToken

CustomerAddressCreationError

Fields

entityIdIntegerRequired

Customer address ID.

firstNameStringRequired

First name of the address owner.

lastNameStringRequired

Last name of the address owner.

address1StringRequired

First line for the street address.

cityStringRequired

City.

countryCodeStringRequired

2-letter country code.

formFieldslist of CustomerFormFieldValuesRequired

The form field values of the customer address.

address2StringOptional

Second line for the street address.

addressTypeDestinationAddressTypeOptional

Address type (Residential or Commercial).

Allowed values:

countryStringOptional

Country name.

countryIdIntegerOptional

Country ID as available in BigCommerce Geography (https://developer.bigcommerce.com/docs/rest-management/geography/countries#get-all-countries).

stateOrProvinceStringOptional

Name of State or Province.

stateIdIntegerOptional

State Id as available in BigCommerce Geography (https://developer.bigcommerce.com/docs/rest-management/geography/states#get-all-states).

phoneStringOptional

Phone number.

postalCodeStringOptional

Postal code.

companyStringOptional

Company name associated with the address.

Referenced by

Fields

AddCustomerAddressResult.address
AddressEdge.node
UpdateCustomerAddressResult.address

Country ID as available in BigCommerce Geography (https://developer.bigcommerce.com/docs/rest-management/geography/countries#get-all-countries).

State Id as available in BigCommerce Geography (https://developer.bigcommerce.com/docs/rest-management/geography/states#get-all-states).