BigCommerce Docs

Retrieves a list of addresses across all Company accounts. Use the parameters to filter results by different attributes like creation date, Company account, and country.

By default, the response does not include address extra fields and values. To include this information, use the isIncludeExtraFields parameter and provide a value of 1.

Retrieves a list of addresses across all Company accounts. Use the parameters to filter results by different attributes like creation date, Company account, and country.

By default, the response does not include address extra fields and values. To include this information, use the isIncludeExtraFields parameter and provide a value of 1.

Authentication

X-Auth-Tokenstring

| Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). | For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

X-Store-Hashstring

| Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Query parameters

limitintegerOptionalDefaults to 10

Determines the number of records to return per page. If left blank, this defaults to 10.

offsetintegerOptional>=0Defaults to 0

The number of results to skip before returning the first result. If left blank, this defaults to 0.

minModifiedintegerOptional

Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses updated after that time.

maxModifiedintegerOptional

Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses updated before that time.

minCreatedintegerOptional

Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses created after that time.

maxCreatedintegerOptional

Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses created before that time.

companyIdintegerOptional

Enter the unique numeric ID of the Company account to return its addresses.

isBillingbooleanOptional

Indicate whether you want to filter for or against billing addresses in the response.

isShippingbooleanOptional

Indicate whether you want to filter for or against shipping addresses in the response.

isIncludeExtraFieldsenumOptionalDefaults to 0

Indicate whether you want to include (1) or exclude (0) address extra fields in the response.

Allowed values:

firstNamestringOptional

Filter for addresses with a specific first name.

lastNamestringOptional

Filter for addresses with a specific last name.

addressstringOptional

Enter the first or second address line to return relevant addresses.

citystringOptional

Filter for addresses from a specific city.

countrystringOptional

Filter for addresses from a specific country. Use the country’s full name or its two-letter ISO code.

statestringOptional

Filter for addresses from a specific state or province. Use the state’s full name or its two-letter ISO code.

zipCodestringOptional

Filter for addresses from a specific postal code.

phoneNumberstringOptional

Filter for addresses with a specific phone number.

externalId[]stringOptional

Filter by an external ID assigned to addresses in a third-party system, such as an ERP.

Response

dataobject

codeintegerDefaults to 200

HTTP Response Code

metaobject

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

| Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Determines the number of records to return per page. If left blank, this defaults to 10.

The number of results to skip before returning the first result. If left blank, this defaults to 0.

Enter a Unix timestamp to retrieve all addresses updated after that time.

Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses updated after that time.

Enter a Unix timestamp to retrieve all addresses updated before that time.

Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses updated before that time.

Enter a Unix timestamp to retrieve all addresses created after that time.

Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses created after that time.

Enter a Unix timestamp to retrieve all addresses created before that time.

Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses created before that time.

Enter the unique numeric ID of the Company account to return its addresses.

Indicate whether you want to filter for or against billing addresses in the response.

Indicate whether you want to filter for or against shipping addresses in the response.

Indicate whether you want to include (1) or exclude (0) address extra fields in the response.

Filter for addresses with a specific first name.

Filter for addresses with a specific last name.

Enter the first or second address line to return relevant addresses.

Filter for addresses from a specific city.

Filter for addresses from a specific country. Use the country’s full name or its two-letter ISO code.

Filter for addresses from a specific state or province. Use the state’s full name or its two-letter ISO code.

Filter for addresses from a specific postal code.

Filter for addresses with a specific phone number.

Filter by an external ID assigned to addresses in a third-party system, such as an ERP.

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Enter a Unix timestamp to retrieve all addresses updated after that time.

Enter a Unix timestamp to retrieve all addresses updated before that time.

Enter a Unix timestamp to retrieve all addresses created after that time.

Enter a Unix timestamp to retrieve all addresses created before that time.

$	curl -G https://api-b2b.bigcommerce.com/api/v3/io/addresses \
>	-H "X-Auth-Token: <apiKey>" \
>	-d firstName=Marie \
>	-d lastName=Curie \
>	--data-urlencode "address=512 Bluebonnet Lane" \
>	-d city=Austin \
>	--data-urlencode "country=United States" \
>	-d state=Texas \
>	-d zipCode=78704 \
>	-d phoneNumber=512-200-1234

1	{
2	"data": {
3	"addressId": 123,
4	"firstName": "Marie",
5	"lastName": "Curie",
6	"phoneNumber": "512-200-1234",
7	"zipCode": "78704",
8	"addressLine1": "512 Bluebonnet Lane",
9	"addressLine2": "Building 1",
10	"city": "Austin",
11	"stateName": "Texas",
12	"countryName": "United States",
13	"stateCode": "TX",
14	"countryCode": "US",
15	"companyId": 123456,
16	"isBilling": true,
17	"isShipping": true,
18	"isDefaultBilling": true,
19	"isDefaultShipping": true,
20	"label": "Austin Warehouse",
21	"externalId": "123456",
22	"extraFields": [
23	{
24	"fieldName": "Tax Provider Tax Code",
25	"fieldValue": "G",
26	"fieldType": 0
27	}
28	]
29	},
30	"code": 200,
31	"meta": {
32	"pagination": {
33	"totalCount": 1,
34	"limit": 10,
35	"offset": 0
36	},
37	"message": "SUCCESS"
38	}
39	}

$	curl -G https://api-b2b.bigcommerce.com/api/v3/io/addresses \
>	-H "X-Auth-Token: <apiKey>" \
>	-d firstName=Marie \
>	-d lastName=Curie \
>	--data-urlencode "address=512 Bluebonnet Lane" \
>	-d city=Austin \
>	--data-urlencode "country=United States" \
>	-d state=Texas \
>	-d zipCode=78704 \
>	-d phoneNumber=512-200-1234

1	{
2	"data": {
3	"addressId": 123,
4	"firstName": "Marie",
5	"lastName": "Curie",
6	"phoneNumber": "512-200-1234",
7	"zipCode": "78704",
8	"addressLine1": "512 Bluebonnet Lane",
9	"addressLine2": "Building 1",
10	"city": "Austin",
11	"stateName": "Texas",
12	"countryName": "United States",
13	"stateCode": "TX",
14	"countryCode": "US",
15	"companyId": 123456,
16	"isBilling": true,
17	"isShipping": true,
18	"isDefaultBilling": true,
19	"isDefaultShipping": true,
20	"label": "Austin Warehouse",
21	"externalId": "123456",
22	"extraFields": [
23	{
24	"fieldName": "Tax Provider Tax Code",
25	"fieldValue": "G",
26	"fieldType": 0
27	}
28	]
29	},
30	"code": 200,
31	"meta": {
32	"pagination": {
33	"totalCount": 1,
34	"limit": 10,
35	"offset": 0
36	},
37	"message": "SUCCESS"
38	}
39	}

List Addresses

List Addresses

Authentication

Query parameters

Response

Authentication

Query parameters

Response