Skip to main content

customerSignupCustomFieldDefinitions

Public: no authentication required.

Lists the organization's own fields the portal's Request a trade account form shows, for the company, the person signing up and their address, before any session exists: buyer-editable fields placed on sign-up. The organization comes from the request host.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

query CustomerSignupCustomFieldDefinitions {
  customerSignupCustomFieldDefinitions {
    id
    type
    archived
    carryForward
    defaultValue
    editPermission
  }
}

Response:

{
  "data": {
    "customerSignupCustomFieldDefinitions": [
      {
        "id": "id",
        "type": "string",
        "archived": true,
        "carryForward": true,
        "defaultValue": {},
        "editPermission": "string"
      }
    ]
  }
}
customerSignupCustomFieldDefinitions(
  subdomain: String
): [CustomFieldDefinition!]!

Arguments​

customerSignupCustomFieldDefinitions.subdomain ● String scalar​

The portal's subdomain. A fallback for local development only: the request host wins.

Type​

CustomFieldDefinition object​

A field the organization added to one kind of record.