List Address Extra Field Configs | BigCommerce Developer Center

Returns a list of available extra fields configurations for Company addresses. We recommend caching the response results to avoid frequent API requests.

Authentication

X-Auth-Tokenstring

Authentication header

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

### Authentication header | 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-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/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

Authentication header

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

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

Query parameters

offsetintegerOptional>=0Defaults to 0

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

limitintegerOptionalDefaults to 10

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

Response

codeintegerDefaults to 200

datalist of objects

metaobject

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/addresses/extra-fields"
4
5	headers = {"X-Auth-Token": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"code": 200,
3	"data": [
4	{
5	"id": 123456,
6	"uuid": "123456",
7	"fieldName": "Tax Provider Tax Code",
8	"fieldType": 0,
9	"isRequired": true,
10	"isUnique": true,
11	"visibleToEnduser": true,
12	"configType": 1,
13	"defaultValue": "Code G",
14	"maximumLength": "100",
15	"numberOfRows": "5",
16	"maximumValue": "1000",
17	"listOfValue": [
18	"Retail",
19	"Automotive",
20	"Manufacturing"
21	]
22	}
23	],
24	"meta": {
25	"pagination": {
26	"totalCount": 1,
27	"limit": 10,
28	"offset": 0
29	},
30	"message": "SUCCESS"
31	}
32	}