List Order Extra Field Configs

Returns a list of available extra fields configurations for B2B orders. 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-fundamentals/api-accounts). | ### Further reading 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

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

limitintegerOptional1-200Defaults 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.

Response

codeintegerDefaults to 200

HTTP Response Code

datalist of objects

metaobject

1	{
2	"code": 1,
3	"data": [
4	{
5	"id": 9798,
6	"uuid": 123456,
7	"fieldName": "Fintech ID",
8	"fieldType": 0,
9	"isRequired": true,
10	"isUnique": false,
11	"visibleToEnduser": true,
12	"configType": 2,
13	"defaultValue": "Enter your Fintech ID here.",
14	"labelName": "Fintech ID",
15	"maximumLength": 100,
16	"numberOfRows": 5,
17	"maximumValue": 1000,
18	"listOfValues": [
19	[
20	"Retail",
21	"Automotive",
22	"Manufacturing"
23	]
24	]
25	}
26	],
27	"meta": {
28	"pagination": {
29	"totalCount": 100,
30	"limit": 10,
31	"offset": 0
32	},
33	"message": "SUCCESS"
34	}
35	}

1	curl https://api-b2b.bigcommerce.com/api/v3/io/orders/extra-fields \
2	-H "X-Auth-Token: <apiKey>"