Item
Any item upon which there is a need to retrieve pre-defined information and that may be priced, or ordered, or invoiced at any point in any supply chain. The item entity is the main entity for rapidly changing master data and is the base for most retail operations. A item can be of several types where a normal StockItem is the most common. Other types of items can be used to represent bundles of items, model definitions to related items of different sizes, colors, styles and fragrances.
type Item {
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
unitOfMeasure: String @deprecated
referencePriceConversionFactor: Float!
referencePriceUnitOfMeasurement: UnitOfMeasure!
salesUnitOfMeasurement: UnitOfMeasure!
needsManualSending: Boolean!
needsApproval: Boolean!
needsLabelPrinting: Boolean!
availableInPos: Boolean!
assortmentTo: DateTime
assortmentFrom: DateTime
assortmentTags: [String]
assortmentPolicyType: AssortmentType!
depositRuleId: String @deprecated
additionalItemIds: [String] @deprecated
brand: String
imageUrls: [String] @deprecated
itemCategoryId: String
tags: [String]
status: ItemStatus!
type: ItemType!
netContent: Decimal
additionalProperties: [AdditionalProperty]
images: [ItemImage]
depositAndFeeRuleIds: [String]
parentId: String
conditionIds: [String]
priceSpecifications(
currentOnly: Boolean
type: PriceType
): [PriceSpecification]
itemIdentifiers(
primaryOnly: Boolean
type: ItemIdentifierType
): [ItemIdentifier]
promotions(
activeOnly: Boolean
): [Promotion]
contentDeclarations: [ContentDeclaration]
itemLinks(
itemLinkTypes: [ItemLinkType!]
): [ItemLink]
parentItem: Item
}
Fields
Item.globalUniqueId ● String scalar
Internal unique ID for CRUD operations and relations. A typical example is: TenantId_itemId_BusinessUnitGroupId
Item.id ● String scalar
Id for the entity. Either external or internal
Item.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.
Item.tenantId ● String scalar
To support multi tenancy we need to be able to identify the customer that owns this information.
Item.name ● String scalar
The name of the entity. This general property can replace the previous ArticleName, StoreName, CampaignName, etc.
Item.description ● String scalar
The description of the entity.
Item.businessUnitId ● String deprecated scalar
BusinessUnitId is obsolete. Use BusinessUnitIds property instead.
Used to assign the entity to tenant's specific business unit.
Item.businessUnitIds ● [String] list scalar
The business units associated with the entity.
Item.businessUnitGroupId ● String scalar
Used to assign the entity to a specific level in a business unit group hierarchy specific to the tenant.
Item.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.
Item.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.
Item.revision ● Long! non-null scalar
Contains evergrowing number used to validate the version of an entity.
Item.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.
Item.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.
Item.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.
Item.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.
Item.unitOfMeasure ● String deprecated scalar
UnitOfMeasure will be removed on 01 Jan 2023. Use SalesUnitOfMeasurement instead.
Item.referencePriceConversionFactor ● Float! non-null scalar
Dictates the factor to convert the price into price per unit as indicated in the ReferencePriceUnitOfMeasurement. I.e 0.5L bottle has a "Price per Litre of X" or A pack of dish washer tablets has a "Price per tablet of X".
Item.referencePriceUnitOfMeasurement ● UnitOfMeasure! non-null enum
This property is a unit of measurement to calculate a reference price.
Item.salesUnitOfMeasurement ● UnitOfMeasure! non-null enum
The Unit of measure the Item is sold in. Usually, EA, KRM, GRM, LTR.
Item.needsManualSending ● Boolean! non-null scalar
Default value: No. Helper property for downstream consumers to know if the item needs to be manually sent to POS. Can also be used in the manual handling process to filter data when loading the items. A calculated value possibly set by many services that might block the item from being available to certain services or consumers. Should be used in conjunction with the AvailableInPos property (Set to No). Must be set to Yes if any rules in any processor deem manual handling is needed. This might be customer specific rules defined later.
Item.needsApproval ● Boolean! non-null scalar
Default value: No. Helper property for downstream consumers to know if the item needs to be manually approved. Can also be used in the approval process to filter data when loading the items. A calculated value possibly set by many services that might block the item from being available to certain services or consumers. Should be used in conjunction with the AvailableInPos property (Set to No). Must be set to Yes if any rules in Approval processor deem approval is needed. This might be customer specific rules defined later.
Item.needsLabelPrinting ● Boolean! non-null scalar
Default value: No. Helper property for downstream consumers to know if the item needs label printing. Can also be used in the printing process to filter data when loading to render the labels. A calculated value possibly set by many services that might block the item from being available to certain services or consumers. Should be used in conjunction with the AvailableInPos property (Set to No). Must be set to Yes if any rules in Label processors deem Label printing is needed. This might be customer specific rules defined later.
Item.availableInPos ● Boolean! non-null scalar
Default value: Yes. Helper property for downstream consumers to know if the item is available for a POS. A calculated value possibly set by many services that might block the item from being sold. I.e. Assortment changes, Label handling, Approval process, etc. Must be set to No if any rules in any processors deem the price as not ready for POS. This might be customer specific rules defined later.
Item.assortmentTo ● DateTime scalar
When the item is in assortment to. Can be null. When set the AssortmentType will be switched to ExpiringAssortment after this datetime passes.
Item.assortmentFrom ● DateTime scalar
When the item is in assortment from. Can be null. When set to a future date the AssortmentType will be set to FutureAssortment until this datetime passes. After passed datetime the AssortmentType will be IN_ASSORTMENT.
Item.assortmentTags ● [String] list scalar
Tags which describe Assortment Policy. Makes it easier to search things.
Item.assortmentPolicyType ● AssortmentType! non-null enum
Enum with the assortment assignment for this item.
Item.depositRuleId ● String deprecated scalar
The depositRuleId is deprecated in favour of depositAndFeeRuleIds.
The deposit rule defined for this item. A deposit rule provides information about deposit amount for the item when recycled for example in a reverse vending machine.
Item.additionalItemIds ● [String] deprecated list scalar
additionalItemIds will be removed on 01 Jan 2023. Use itemIdentifiers as a sub entity or use the Item Identifier Query API instead.
List of ids for Item Identifiers.
Item.brand ● String scalar
The brand of the product.
Item.imageUrls ● [String] deprecated list scalar
The ImageUrls is deprecated in favour of new Images field.
An image URL to a picture of the product. This can be our own Cloud Storage image repository or an outside image repository.
Item.itemCategoryId ● String scalar
ItemCategory that the item is placed in.
Item.tags ● [String] list scalar
List of searchable texts that can be used to search, group and filter the products.
Item.status ● ItemStatus! non-null enum
The status of the entity.
Item.type ● ItemType! non-null enum
The Type is used to separate items that need special characteristics like Pharmaceutical items, bundles or structures of items or services, etc.
Item.netContent ● Decimal scalar
The net content of the product. This is a decimal value as needed, and should be evaluated together with UnitOfMeasure to make sense.
Item.additionalProperties ● [AdditionalProperty] list object
List of customer specific values on the entity level.
Item.images ● [ItemImage] list object
A list of Item images.
Item.depositAndFeeRuleIds ● [String] list scalar
Ids referencing deposit and fee rules that should apply to this Item. Most common use case is for bottle deposit where an additional, refundable amount will be added to the receipt when the Item is purchased.
Item.parentId ● String scalar
A reference to a parent item by it’s ID property. Used for linking virtual items with same or similar stock items. Primary example is variants of a model like different sizes and colors of a specific garment.
Item.conditionIds ● [String] list scalar
Identifiers of the Entity Conditions applicable to this Item. 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.
Item.priceSpecifications ● [PriceSpecification] list object
The list of price specifications.
Item.priceSpecifications.currentOnly ● Boolean scalar
Select only current price specifications. The default value is false.
Item.priceSpecifications.type ● PriceType enum
The type of price specifications to filter by.
Item.itemIdentifiers ● [ItemIdentifier] list object
The list of item identifiers.
Item.itemIdentifiers.primaryOnly ● Boolean scalar
Select only primary item identifiers. The default value is false.
Item.itemIdentifiers.type ● ItemIdentifierType enum
The type of item identifiers to filter by.
Item.promotions ● [Promotion] list object
The list of promotions.
Item.promotions.activeOnly ● Boolean scalar
Select only active promotions. The default value is false.
Item.contentDeclarations ● [ContentDeclaration] list object
The list of content declarations.
Item.itemLinks ● [ItemLink] list object
The item links which have this item as the parent item or one of the linked items.
Item.itemLinks.itemLinkTypes ● [ItemLinkType!] list enum
The types of item links to filter by.
Item.parentItem ● Item object
The parent item.
Returned By
item query
Member Of
CompleteItem object ● Item object ● ItemIdentifier object ● ItemLink object ● ItemsConnection object ● ItemsEdge object ● ItemWithIdentifiers object ● LinkedItem object ● PotentialDuplicateItemIdentifier object