List Order Extra Field Configs

GET

https://api-b2b.bigcommerce.com/api/v3/io/orders/extra-fields

GET

/api/v3/io/orders/extra-fields

curl -G https://api-b2b.bigcommerce.com/api/v3/io/orders/extra-fields \
     -H "X-Auth-Token: <apiKey>" \
     -d limit=15 \
     -d offset=5

200Orders_get-orders-extra-fields_example

{
  "code": 200,
  "data": [
    {
      "id": 9798,
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fieldName": "Fintech ID",
      "labelName": "Fintech ID",
      "fieldType": 0,
      "isRequired": true,
      "isUnique": false,
      "visibleToEnduser": true,
      "configType": 2,
      "defaultValue": "",
      "maximumLength": "100"
    },
    {
      "id": 9799,
      "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "fieldName": "Industry",
      "labelName": "Industry",
      "fieldType": 3,
      "isRequired": false,
      "isUnique": false,
      "visibleToEnduser": true,
      "configType": 2,
      "defaultValue": "Retail",
      "listOfValue": [
        "Retail",
        "Automotive",
        "Manufacturing"
      ]
    }
  ],
  "meta": {
    "pagination": {
      "totalCount": 2,
      "limit": 10,
      "offset": 0
    },
    "message": "SUCCESS"
  }
}

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

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.

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

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

codeintegerOptionalDefaults to 200

HTTP Response Code

datalist of objectsOptional

metaobjectOptional