Get Company Default Addresses

GET

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

GET

/api/v2/companies/:companyId/default-addresses

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

200200 - SUCCESS

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

Returns a Company’s default shipping and billing addresses. Use Update Address Information to change which addresses are set as the defaults.

Equivalent Storefront GraphQL API Query: defaultBillingAddress for the billing address and defaultShippingAddress for the shipping 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.

Response

messagestringOptional

codedoubleOptionalDefaults to 200

dataobjectOptional