ItemLink

A Item Link describes a relation between two or more items. A item link can be used for several different reasons as indicated by the Item Link Type.

type ItemLink {
  globalUniqueId: String
  id: String
  correlationId: String
  tenantId: String
  name: String
  description: String
  businessUnitId: String @deprecated
  businessUnitIds: [String]
  businessUnitGroupId: String
  businessUnitHierarchyLevel: Int
  version: Int!
  revision: Long!
  created: DateTime!
  createdBy: String
  modified: DateTime!
  modifiedBy: String
  status: ItemLinkStatus!
  itemId: String
  linkedItemIdsAsString: String @deprecated
  linkedItems: [LinkedItem]
  relationType: ItemLinkType!
  priority: Int
  additionalProperties: [itemLinks_AdditionalProperty]
  conditionIds: [String]
  parentItem: Item
}

Fields

ItemLink.globalUniqueId ● String scalar

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

ItemLink.id ● String scalar

Id for the entity. Either external or internal

ItemLink.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.

ItemLink.tenantId ● String scalar

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

ItemLink.name ● String scalar

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

ItemLink.description ● String scalar

The description of the entity.

ItemLink.businessUnitId ● String deprecated scalar

DEPRECATED

BusinessUnitId is obsolete. Use BusinessUnitIds property instead.

Used to assign the entity to tenant's specific business unit.

ItemLink.businessUnitIds ● [String] list scalar

The business units associated with the entity.

ItemLink.businessUnitGroupId ● String scalar

Used to assign the entity to a specific level in a business unit group hierarchy specific to the tenant.

ItemLink.businessUnitHierarchyLevel ● Int scalar

Indicates on which level in the business unit group hierarchy the entity is defined. The property is used for prioritizing which definition to use, if several exists. The higher the number the higher the priority should be considered.

ItemLink.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.

ItemLink.revision ● Long! non-null scalar

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

ItemLink.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.

ItemLink.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.

ItemLink.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.

ItemLink.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.

ItemLink.status ● ItemLinkStatus! non-null enum

The status of the entity.

ItemLink.itemId ● String scalar

The Item this or these linked items relate to.

ItemLink.linkedItemIdsAsString ● String deprecated scalar

DEPRECATED

LinkedItemIdsAsString is deprecated. Use LinkedItems instead.

Concatenated linked Item IDs with ',' as a separator.

ItemLink.linkedItems ● [LinkedItem] list object

Array of LinkedItem containing the linked items that relate to the "parent" item in the way the ItemLinkType defines and the quantity of each linked item needed for this specific product.

ItemLink.relationType ● ItemLinkType! non-null enum

The type of relation the LinkedItemIds have to the "parent" item.

ItemLink.priority ● Int scalar

If several links of the same link type exists, the priority will provide information on how to prioritize among them.

ItemLink.additionalProperties ● [itemLinks_AdditionalProperty] list object

List of customer specific values on the entity level. NOT nullable, but can be empty.

ItemLink.conditionIds ● [String] list scalar

Identifiers of the Entity Conditions applicable to this Item Link. Entity Conditions are intent-based metadata records, owned by the Entity Conditions service, that instruct consuming systems (e.g. POS, UI, Electronic Shelf Labels, external devices) how an entity must be handled - covering legal, business, sales, entity and 3rd party requirements such as age verification or security tag removal.

ItemLink.parentItem ● Item object

The parent item.

Member Of

CompleteItem object ● Item object ● ItemLinksConnection object ● ItemLinksEdge object ● ItemWithIdentifiers object