For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
          • QUERYcompanyRoles
          • QUERYcompanyRole
          • QUERYcompanyPermissions
          • QUERYaccountSettings
          • QUERYcustomerAccountSettings
          • QUERYinvoices
          • QUERYinvoice
          • QUERYinvoiceStats
          • QUERYinvoiceCustomerInformation
          • QUERYinvoicePaymentModules
          • QUERYinvoiceBcOrderAllowMethods
          • QUERYinvoicePaymentBcCart
          • QUERYinvoicePaymentFees
          • QUERYreceipts
          • QUERYreceipt
          • QUERYallReceiptLines
          • QUERYreceiptLine
          • QUERYreceiptLines
          • QUERYorder
          • QUERYallOrders
          • QUERYorderProducts
          • QUERYorderedProducts
          • QUERYcustomerOrders
          • QUERYcustomerOrder
          • QUERYcreatedByUser
          • QUERYshoppingLists
          • QUERYshoppingList
          • QUERYshoppingListsIdName
          • QUERYcustomerShoppingLists
          • QUERYcustomerShoppingList
          • QUERYcustomerShoppingListsIdName
          • QUERYcompanyExtraFields
          • QUERYuserCompany
          • QUERYcompanyValidateEmail
          • QUERYcompanyUserInfo
          • QUERYaccountFormFields
          • QUERYcompanyCreditConfig
          • QUERYcompanyPaymentTerms
          • QUERYcompanySubsidiaries
          • QUERYsuperAdminCompanies
          • QUERYsuperAdminMasquerading
          • QUERYquotes
          • QUERYcustomerQuotes
          • QUERYquote
          • QUERYquoteUserStoreInfo
          • QUERYquoteConfig
          • QUERYquoteExtraFieldsConfig
          • QUERYusers
          • QUERYuser
          • QUERYuserEmailCheck
          • QUERYcustomerEmailCheck
          • QUERYuserExtraFields
          • QUERYcurrentUser
          • QUERYcustomerInfo
          • QUERYuserLoginState
          • QUERYuserMasqueradingCompany
          • QUERYorderStatuses
          • QUERYbcOrderStatuses
          • QUERYcurrencies
          • QUERYautoLoader
          • QUERYstoreLimitations
          • QUERYstoreBasicInfo
          • QUERYstorefrontScript
          • QUERYstorefrontDefaultLanguage
          • QUERYstorefrontProductSettings
          • QUERYstorefrontSettings
          • QUERYstoreConfigSwitchStatus
          • QUERYstoreCheckoutConfig
          • QUERYstorefrontConfig
          • QUERYstorefrontConfigs
          • QUERYproductVariantsInfo
          • QUERYvariantSku
          • QUERYproductsInventory
          • QUERYproductsLoad
          • QUERYproductsSearch
          • QUERYtaxZoneRates
          • QUERYproductPurchasable
          • QUERYvalidateProduct
          • QUERYvalidateProducts
          • QUERYpriceProducts
          • QUERYaddresses
          • QUERYaddress
          • QUERYcountries
          • QUERYdefaultShippingAddress
          • QUERYdefaultBillingAddress
          • QUERYcustomerAddresses
          • QUERYcustomerAddress
          • QUERYaddressConfig
          • QUERYaddressExtraFields
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLB2BQueries

companyExtraFields

Example Query
1query ExampleQuery($storeHash: String) {
2 companyExtraFields(storeHash: $storeHash) {
3 fieldName
4 fieldType
5 isRequired
6 defaultValue
7 maximumLength
8 numberOfRows
9 maximumValue
10 listOfValue
11 visibleToEnduser
12 labelName
13 }
14}
Variables
1{
2 "storeHash": "example"
3}
Example response
1{
2 "data": {
3 "companyExtraFields": [
4 {
5 "fieldName": "example",
6 "fieldType": 0,
7 "isRequired": true,
8 "defaultValue": "example",
9 "maximumLength": "example",
10 "numberOfRows": "example",
11 "maximumValue": "example",
12 "listOfValue": [
13 "example"
14 ],
15 "visibleToEnduser": true,
16 "labelName": "example"
17 }
18 ]
19 }
20}
Get extra fields configurations of a company. Doesn't require a Token.
Was this page helpful?
Previous

customerShoppingListsIdName

Next

userCompany

Built with

Arguments

storeHashStringRequired
The store hash. This field is required.

Returns

an optional list of optional ExtraFieldsConfigType
fieldNameString
Field name that config in you store
fieldTypeInteger
Field type of the extra field.0 means text type. 1 means textarea type. 2 means number type. 3 means dropdown type.
isRequiredBoolean
Is this field is required
defaultValueString
Default value of this field.
maximumLengthString

The maximum length of the value of this field. fieldType == 0

numberOfRowsString

The maximum number of rows of the value of this field. fieldType == 1

maximumValueString

Maximum value of the field value. fieldType == 2

listOfValuelist of optional Strings

List of all optional values for the field value. fieldType == 3

visibleToEnduserBoolean
Is this field visible to end user
labelNameString
The label name of the field.