Skip to main content

ItemCategory

An Item Category is one element in a hierarchical structure used to group Items. This is a customer specific grouping relevant to how the retailer wants to group it's Items.

type ItemCategory {
  entityMetadata: TenantWideEntityMetadataV1 @deprecated
  status: ItemCategoryStatus!
  level: String
  code: String
  parentId: String
  additionalProperties: [AdditionalProperty]
  globalUniqueId: String
  id: String
  correlationId: String
  tenantId: String
  name: String
  description: String
  version: Int!
  revision: Long!
  created: DateTime!
  createdBy: String
  modified: DateTime!
  modifiedBy: String
}

Fields​

ItemCategory.entityMetadata ● TenantWideEntityMetadataV1 deprecated object​

[DEPRECATED]

EntityMetadata will be removed after 2023-01-01. Use the entity metadata properties on the entity level instead.

ItemCategory.status ● ItemCategoryStatus! non-null enum​

Status of the entity.

ItemCategory.level ● String scalar​

Level in the hierarchy.

ItemCategory.code ● String scalar​

Optional additional code.

ItemCategory.parentId ● String scalar​

Reference to GlobalUniqueId for the parent entity.

ItemCategory.additionalProperties ● [AdditionalProperty] list object​

List of customer specific values on the entity level.

ItemCategory.globalUniqueId ● String scalar​

Internal unique ID for CRUD operations and relations. A typical example is: TenantId_ItemCategoryId

ItemCategory.id ● String scalar​

Id for the entity. Either external or internal

ItemCategory.correlationId ● String scalar​

ID for tracing an entity and/or a group of sub entities through the application. Might be external, and if missing from the producer of data the API will add an ID. Must be used in all logging and tracing.

ItemCategory.tenantId ● String scalar​

To support multi tenancy we need to be able to identify the customer that owns this information.

ItemCategory.name ● String scalar​

The name of the entity. This general property can replace the previous ArticleName, StoreName, CampaignName, etc.

ItemCategory.description ● String scalar​

The description of the entity.

ItemCategory.version ● Int! non-null scalar​

Version of the entity. Must be updated when there is a change to the entity. An ever increasing Integer.

Use revision instead of version if you need a more precise versioning mechanism.

ItemCategory.revision ● Long! non-null scalar​

Contains evergrowing number used to validate the version of an entity.

ItemCategory.created ● DateTime! non-null scalar​

When the object was first created. This timestamp will be set by the input API POST-endpoints before creating the AVRO data for processing.

ItemCategory.createdBy ● String scalar​

Who created. Will be an ID and must be looked up in the user DB. This ID will be set by the input API POST-endpoints before creating the AVRO data for processing.

ItemCategory.modified ● DateTime! non-null scalar​

When the object was modified. Will be updated along with the Version property. This timestamp will be set by the input API PUT and PATCH-endpoints before creating the AVRO data for processing.

ItemCategory.modifiedBy ● String scalar​

Who created or modified the object. Will be an ID and must be looked up in the user DB. This ID will be set by the input API PUT and PATCH-endpoints before creating the AVRO data for processing.

Member Of​

ItemCategoriesConnection object ● ItemCategoriesEdge object ● PrintSchedule object