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
          • Authentication
          • Catalog
          • Company
              • GETList Countries
              • GETGet Address Edit Permission
              • GETList Company Addresses
              • POSTCreate Company Address
              • GETSearch Company Addresses
              • POSTSearch Addresses with Multiple Filters
              • GETGet Address
              • PUTUpdate Address Information
              • PUTMark Address as Active or Inactive
              • GETGet Company Default Addresses
          • Orders
          • Request for Quote
          • Sales Rep
          • Shopping List
          • Store Settings
      • Management
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTB2BStorefrontCompanyAddresses

Update Address Information

PUT
https://api-b2b.bigcommerce.com/api/v2/companies/:companyId/addresses/:addressId
PUT
/api/v2/companies/:companyId/addresses/:addressId
$curl -X PUT https://api-b2b.bigcommerce.com/api/v2/companies/123/addresses/123 \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "addressId": "27",
>  "isDefaultBilling": "0",
>  "isDefaultShipping": "0",
>  "label": "Austin Warehouse",
>  "lastName": "Curie",
>  "country": {
>    "countryName": "United States",
>    "countryCode": "US"
>  },
>  "extraFields": [
>    {
>      "fieldName": "Company Tax Code",
>      "fieldValue": "Code G"
>    }
>  ],
>  "firstName": "Marie",
>  "isBilling": "0",
>  "isShipping": "1",
>  "phoneNumber": "8001234567",
>  "state": {
>    "stateName": "Texas",
>    "stateCode": "TX"
>  },
>  "addressLine1": "512 Bluebonnet Lane",
>  "addressLine2": "Building 2",
>  "city": "Austin",
>  "zipCode": "78726"
>}'
200Updated
1{
2  "message": "string",
3  "code": 200,
4  "data": {
5    "addressId": "27"
6  }
7}
Updates the details of a billing or shipping address, if address book management is enabled for your storefront. Equivalent Storefront GraphQL API Mutation: `addressUpdate`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).
Was this page helpful?
Previous

Get Address

Next

Mark Address as Active or Inactive

Built with

Updates the details of a billing or shipping address, if address book management is enabled for your storefront.

Equivalent Storefront GraphQL API Mutation: addressUpdate. 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](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api) section[...]

Path parameters

companyIdstringRequired
The unique numeric ID of the Company account.
addressIdstringRequired
The unique ID of the address.

Request

This endpoint expects an object.
addressIdstringRequired
The unique ID of the address.
isDefaultBillingstringRequired
Indicates whether the address is the default billing address for the Company account.
isDefaultShippingstringRequired
Indicates whether the address is the default shipping address for the Company account.
labelstringRequired
The label used on the storefront to identify the address.
lastNamestringRequired
The last name of the address.
countryobjectOptional

Country of the address as an object with both the name and the two-character code.

extraFieldslist of objectsOptional
firstNamestringOptional
The first name of the address.
isBillingstringOptional
Indicates whether the address can be used as a billing address.
isShippingstringOptional
Indicates whether the address can be used as a shipping address.
phoneNumberstringOptional
The phone number associated with the address.
stateobjectOptional

State of the address as an object with both the name and the two-character code.

Response

OK
messagestring
codedoubleDefaults to 200
dataobject

Authentication header

HeaderArgumentDescription
AuthorizationBearer {{B2B_JWT_TOKEN}}You can obtain this token using the steps described in the REST Storefront API section[…]