AdditionalItemId

A additional item id represents a product identification code of some sort. Usually it is a barcode like a GTIN but it might be a Non-standard code for special use-cases or it might be a PLU code for specific PLU use-cases. It can also be a QR code or other machine registrable code.

type AdditionalItemId {
  value: String
  itemId: String
  type: AdditionalItemIdType!
  status: AdditionalItemIdStatus!
  entityMetadata: EntityMetadataV1 @deprecated
  additionalProperties: [AdditionalProperty]
  globalUniqueId: String
  id: String
  correlationId: String
  tenantId: String
  name: String
  description: String
  businessUnitId: String @deprecated
  businessUnitIds: [String]
  businessUnitGroupId: String
  version: Int!
  revision: Long!
  created: DateTime!
  createdBy: String
  modified: DateTime!
  modifiedBy: String
}

Fields

AdditionalItemId.value ● String scalar

The actual additional item id value.

AdditionalItemId.itemId ● String scalar

The Item Id the additional item id is applicable to.

AdditionalItemId.type ● AdditionalItemIdType! non-null enum

The additional item id type. Usually GTIN (Default) but can be of several other types.

AdditionalItemId.status ● AdditionalItemIdStatus! non-null enum

The additional item id status.

AdditionalItemId.entityMetadata ● EntityMetadataV1 deprecated object

[DEPRECATED]

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

The base entity information.

AdditionalItemId.additionalProperties ● [AdditionalProperty] list object

The list of additional properties.

AdditionalItemId.globalUniqueId ● String scalar

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

AdditionalItemId.id ● String scalar

Id for the entity. Either external or internal

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

AdditionalItemId.tenantId ● String scalar

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

AdditionalItemId.name ● String scalar

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

AdditionalItemId.description ● String scalar

The description of the entity.

AdditionalItemId.businessUnitId ● String deprecated scalar

[DEPRECATED]

BusinessUnitId is obsolete. Use BusinessUnitIds property instead.

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

AdditionalItemId.businessUnitIds ● [String] list scalar

The business units associated with the entity.

AdditionalItemId.businessUnitGroupId ● String scalar

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

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

AdditionalItemId.revision ● Long! non-null scalar

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

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

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

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

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

Returned By

additionalItemId query

Member Of

AdditionalItemIdsConnection object ● AdditionalItemIdsEdge object