Skip to main content

attributeDefinitions

The company’s attribute definitions for one kind of record, such as “Material” on a product.

Business Rules​

  • Scoped to the company in the X-Company-Id header and to the kind of record in entityType
  • Archived definitions are left out unless archiveStatus asks for them
  • attributeClass is derived from the settings and the attribute type rather than stored

Error Scenarios​

  • CompanyContextRequired when no company is in context

Permissions Required​

  • The read permission of the entity type, such as products:get_attribute_definitions for PRODUCT
attributeDefinitions(
  after: String
  before: String
  entityType: AttributeEntityTypeEnum!
  filters: AttributeDefinitionFilterInput
  first: Int
  last: Int
): AttributeDefinitionConnection!

Arguments​

attributeDefinitions.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

attributeDefinitions.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

attributeDefinitions.entityType ● AttributeEntityTypeEnum! non-null enum common​

The kind of record whose definitions to return.

attributeDefinitions.filters ● AttributeDefinitionFilterInput input common​

Filtering and sorting options.

attributeDefinitions.first ● Int scalar common​

Returns the first _n_ elements from the list.

attributeDefinitions.last ● Int scalar common​

Returns the last _n_ elements from the list.

Type​

AttributeDefinitionConnection object common​

The connection type for AttributeDefinition.