Get Address

GET

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

GET

/api/v2/companies/:companyId/addresses/:addressId

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

200Get an Address

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

Returns a specific address based on the companyId and addressId in the path.

Equivalent Storefront GraphQL API Query: address. 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.

addressIdstringRequired

The unique ID of the address.

Response

messagestringOptional

codedoubleOptionalDefaults to 200

dataobjectOptional

Extra Field Values