Update Address Information | BigCommerce Developer Center

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

addressIdstringRequired

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.

addressLine1stringOptional

The first line of the address

addressLine2stringOptional

The second line of the address

citystringOptional

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

zipCodestringOptional

Zip or Postal Code of the address.

Response

codedoubleDefaults to 200

dataobject

messagestringDefaults to SUCCESS

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v2/companies/companyId/addresses/addressId"
4
5	payload = {
6	"addressId": "27",
7	"isDefaultBilling": "0",
8	"isDefaultShipping": "0",
9	"label": "Austin Warehouse",
10	"lastName": "Curie",
11	"addressLine1": "512 Bluebonnet Lane",
12	"addressLine2": "Building 2",
13	"city": "Austin",
14	"country": {
15	"countryName": "United States",
16	"countryCode": "US"
17	},
18	"extraFields": [
19	{
20	"fieldName": "Company Tax Code",
21	"fieldValue": "Code G"
22	}
23	],
24	"firstName": "Marie",
25	"isBilling": "0",
26	"isShipping": "1",
27	"phoneNumber": "8001234567",
28	"state": {
29	"stateName": "Texas",
30	"stateCode": "TX"
31	},
32	"zipCode": "78726"
33	}
34	headers = {
35	"Authorization": "Bearer <token>",
36	"Content-Type": "application/json"
37	}
38
39	response = requests.put(url, json=payload, headers=headers)
40
41	print(response.json())

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