For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
      • Storefront
      • Management
        • Overview
          • Addresses
            • GETGet Country
            • GETGet State
            • GETList Addresses
            • POSTCreate Company Address
            • GETGet Address
            • PUTUpdate Address
            • DELDelete Address
            • POSTBulk Create Addresses
            • GETList Address Extra Field Configs
          • Authentication
          • Channels
          • Company
          • Invoice Management
          • Orders
          • Payment
          • Quotes
          • Sales Staff
          • Shopping List
          • Super Admin
          • Users
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTB2BManagementAddresses

Get Address

GET
https://api-b2b.bigcommerce.com/api/v3/io/addresses/:addressId
GET
/api/v3/io/addresses/:addressId
$curl https://api-b2b.bigcommerce.com/api/v3/io/addresses/123 \
>     -H "X-Auth-Token: <apiKey>"
1{
2  "code": 200,
3  "data": {
4    "addressId": 123,
5    "firstName": "Marie",
6    "lastName": "Curie",
7    "phoneNumber": "512-200-1234",
8    "zipCode": "78704",
9    "addressLine1": "512 Bluebonnet Lane",
10    "addressLine2": "Building 1",
11    "city": "Austin",
12    "stateName": "Texas",
13    "countryName": "United States",
14    "stateCode": "TX",
15    "countryCode": "US",
16    "companyId": 123456,
17    "isBilling": true,
18    "isShipping": true,
19    "isDefaultBilling": true,
20    "isDefaultShipping": true,
21    "label": "Austin Warehouse",
22    "externalId": "123456",
23    "extraFields": [
24      {
25        "fieldName": "Tax Provider Tax Code",
26        "fieldValue": "G",
27        "fieldType": 0
28      }
29    ]
30  },
31  "meta": {
32    "message": "SUCCESS"
33  }
34}
Retrieves detailed information on a single Company address.
Was this page helpful?
Previous

Create Company Address

Next

Update Address

Built with

Authentication

X-Auth-Tokenstring
HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring
HeaderArgumentDescription
X-Store-Hashstore_hashThe unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

addressIdstringRequired
The unique numeric identifier of the Company address.

Response

OK
codeintegerDefaults to 200
dataobject
metaobject

Errors

404
Not Found Error