List Quote Extra Fields Configs

GET

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

GET

/api/v3/io/rfq/extra-fields

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

200Quotes_get-rfq-extra-fields_example

{
  "code": 200,
  "data": [
    {
      "id": 31,
      "uuid": "efb3a9d2-4c7a-4f3e-9a2b-1d2f3e4c5b6a",
      "fieldName": "Customer Priority",
      "labelName": "Customer Priority",
      "fieldType": 3,
      "isRequired": true,
      "isUnique": false,
      "visibleToEnduser": true,
      "configType": 2,
      "defaultValue": "normal",
      "listOfValue": [
        "low",
        "normal",
        "high"
      ],
      "valueConfigs": {
        "defaultValue": "normal",
        "maximumLimit": "",
        "listOfValue": [
          "low",
          "normal",
          "high"
        ]
      }
    },
    {
      "id": 32,
      "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "fieldName": "Project Code",
      "labelName": "Project Code",
      "fieldType": 0,
      "isRequired": false,
      "isUnique": false,
      "visibleToEnduser": true,
      "configType": 2,
      "defaultValue": "",
      "maximumLength": "20",
      "valueConfigs": {
        "defaultValue": "",
        "maximumLimit": "20",
        "listOfValue": []
      }
    }
  ],
  "meta": {
    "message": "SUCCESS",
    "pagination": {
      "totalCount": 2,
      "offset": 0,
      "limit": 10
    }
  }
}

Returns a list of available extra fields configs for sales quotes. 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

offsetintegerOptionalDefaults 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

codeintegerOptionalDefaults to 200

HTTP Response Code

datalist of objectsOptional

metaobjectOptional