List Company Addresses

GET

https://api-b2b.bigcommerce.com/api/v2/companies/:companyId/addresses

GET

/api/v2/companies/:companyId/addresses

curl https://api-b2b.bigcommerce.com/api/v2/companies/123/addresses \
     -H "Authorization: Bearer <token>"

200200 - SUCCESS

{
  "message": "Success",
  "code": 200,
  "data": {
    "addresses": {
      "27": {
        "addressId": 27,
        "addressLine1": "512 Bluebonnet Lane",
        "addressLine2": "Building 2",
        "city": "Austin",
        "country": {
          "countryCode": "US",
          "countryName": "United States"
        },
        "extraFields": [
          {
            "fieldName": "Company Tax Code",
            "fieldValue": "Code G"
          }
        ],
        "firstName": "Marie",
        "isBilling": 0,
        "isShipping": 1,
        "lastName": "Curie",
        "phoneNumber": "8001234567",
        "state": {
          "stateCode": "TX",
          "stateName": "Texas"
        },
        "zipCode": "78726"
      }
    },
    "defaultShippingId": "17",
    "defaultBillingId": "76",
    "canEnterNewAddress": true
  }
}

Returns the billing and shipping addresses associated with a particular Company account.

Equivalent Storefront GraphQL API Query: addresses. For more information, see the 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[…]

Path parameters

companyIdstringRequired

The unique numeric ID of the Company account.

Response

messagestringOptional

codedoubleOptionalDefaults to 200

dataobjectOptional