BigCommerce Docs

curl -X PUT https://api-b2b.bigcommerce.com/api/v2/companies/123/addresses/123 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "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"
    }
  ]
}'

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.

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).

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[…]

### 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

Extra Field Values

firstNamestringRequired

The first name of the address.

isShippingstringRequired

Indicates whether the address can be used as a shipping address.

isBillingstringRequired

Indicates whether the address can be used as a billing address.

phoneNumberstringRequired

The phone number associated with the address.

addressLine1stringRequired

The first line of the address

addressLine2stringRequired

The second line of the address

citystringRequired

City of the address.

zipCodestringRequired

Zip or Postal Code of the address.

stateobjectRequired

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

countryobjectRequired

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

addressIdstringRequired

The unique ID of the address.

lastNamestringRequired

The last name of the address.

isDefaultShippingstringRequired

Indicates whether the address is the default shipping address for the Company account.

isDefaultBillingstringRequired

Indicates whether the address is the default billing address for the Company account.

labelstringRequired

The label used on the storefront to identify the address.

extraFieldslist of objectsOptional

Response

messagestring

codedoubleDefaults to 200

dataobject

1	{
2	"message": "string",
3	"code": 200,
4	"data": {
5	"addressId": "27"
6	}
7	}