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

accountFormFields

Example Query
1query ExampleQuery($storeHash: String, $formType: Int) {
2 accountFormFields(storeHash: $storeHash, formType: $formType) {
3 id
4 createdAt
5 updatedAt
6 formType
7 fieldFrom
8 fieldId
9 fieldIndex
10 custom
11 groupId
12 groupName
13 }
14}
Variables
1{
2 "storeHash": "example",
3 "formType": 0
4}
Example response
1{
2 "data": {
3 "accountFormFields": [
4 {
5 "id": "example",
6 "createdAt": 0,
7 "updatedAt": 0,
8 "formType": 0,
9 "fieldFrom": 0,
10 "fieldId": "example",
11 "fieldIndex": 0,
12 "custom": true,
13 "groupId": 0,
14 "groupName": "example"
15 }
16 ]
17 }
18}
Get a list of form fields for an account. Doesn't require a Token.
Was this page helpful?
Previous

companyUserInfo

Next

companyCreditConfig

Built with

Arguments

storeHashStringRequired
The Store Hash. This field is required.
formTypeIntegerRequired
The form type. This field is required.

Returns

an optional list of optional AccountFormFieldsType
idString
Unique ID of this company
createdAtInteger
The created at of this field
updatedAtInteger
The updated at of this field
formTypeInteger
The form type of this field
fieldFromInteger
The field from of this field
fieldIdString
The field ID of this field
fieldIndexInteger
The field index of this field
customBoolean
Is this field custom
groupIdInteger
The group ID of this field
groupNameString
The group name of this field
isRequiredBoolean
Is this field required
visibleBoolean
Is this field visible
labelNameString
The label name of this field
fieldNameString
The field name of this field
fieldTypeString
The field type of this field
valueConfigsGenericScalar
The value configs of this field