Field Definitions / Phygrid Developers

This document contains the definition of all fields mentioned in the Grid Products data-model document.

Nested structures are indicated by separate headers.

Field	Description	Required	Example
`productId`	Primary ID of the product	Yes	`product1`
`spaceIds`	List of spaceIds where product will be visible		`[<array of ombori generated spaceId>]`
`introductionDate`	Date when product is available/added		`2012-05-05`
`plannedAbandonmentDate`	Date when product is to be abandoned		`2030-05-05`
`shellLifeDays`			`30`
`productType`	List of Product Type IDs applicable to this product as a reference from ProductTypes Database		`["furniture", "outdoor"]`

productName

productName is a required property that contains an Array of Objects, one is required, which each has the following properties

Field	Description	Required	Example
`productName`	Translation value of the product name	Yes	`Shirt`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	ISOLanguageID

productDescription

productDescription is a required property that contains an Array of Objects, one is required, which each has the following properties

Field	Description	Required	Example
`productDescription`	Translation value of the product name	Yes	`Brand New`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	ISOLanguageID

relatedProductGroups

relatedProductGroups is not required.

Field	Description	Required	Example
`relatedProductGroupId`	ID of the related product	Yes	`P1001`
`productRelationshipType`	Relationship of the related product to the product	Yes	`Recommended`

variants

variants is a required field.

Field	Description	Required	Example
`productId`	Variant’s product ID	Yes	`P1001_01`
`productGroupId`	Product Group ID where variant belongs to	Yes	`P1001`
`globalTradeItemNumber`	Array of variant’s Global Trade Item Number		`[]`
`gtinName`	Array of variant’s Gtin Name		`[]`
`europeanArticleNumber`	Array of variant’s European Article Number		`[]`
`universalProductCode`	Array of variant’s Universal Product Code		`[]`
`periodStartDate`	Date when variant was added		`2021-01-01`
`periodEndDate`	Date when variant will end		`2024-03-04`
`productName`	The Name of the product variant, using the productName structure as above		`productName`
`color`	Variant color		`Red`
`colorImageUrl`	Image to be used as variant picker on apps		`https://assets.example.com/images/image5.png`
`size`	Variant size		`M`
`style`	Variant style		`Summer`

productStatus

productStatus is a required field.

Field	Description	Required	Example
`productStatus`	Status value of the product	Yes	`ProductStatus`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`
`spaceId`	Space where product status is applicable	Yes	`<ombori generated spaceId>`
`periodStartDate`	Status duration start
`periodEndDate`	Status duration end
`productStatusNote`

productFeature

productFeature is not required.

Field	Description	Required	Example
`productId`	Variant ID	Yes	`P1001_01`
`productFeatureType`	Key of the product feature	Yes	`color`
`productFeatureValue`	Translated value of the product feature	Yes	`Red`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`

productPriceList

productPriceList is a required field.

Field	Description	Required	Example
`productId`	Variant ID	Yes	`P1001_01`
`priceListType`	Standard or Promotional	Yes	`Standard`
`spaceId`	Space where price list is applicable	Yes	`<ombori generated spaceId>`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`
`isoCurrencyCode`	Iso Currency Code	Yes	`IsoCurrencyCode List`
`pricingUomId`
`periodStartTimestamp`	Price applicable start date
`periodEndTimestamp`	Price applicable end date
`suggestedRetailPrice`			`25.50`
`listPrice`		Yes	`20.00`

catalogPageLocationProduct

Field	Description	Required	Example
`productId`	Variant ID	Yes	`P1001_01`
`productGroupId`	Parent ID	Yes	`P1001`
`catalogType`	Type of the image/media		`image/png`, `video/mp4`
`catalogPage`	Root URL where image/media is found		`https://assets.example.com`
`catalogPageLocation`	ID or route where image/media is found		`/images/image5.png`
`catalogPageLocationProduct`	Entire URL where image/media is found	Yes	`https://assets.example.com/images/image5.png`

productLabel

productLabel is not a required property that contains an Array of Objects, one is required, which each has the following properties.

Field	Description	Required	Example
`productLabel`	Translation value of the product label	Yes	`Online Exclusive`
`spaceId`	Space where product label is applicable	Yes	`<ombori generated spaceId>`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`

productTags

productTags is not a required property that contains an Array of Objects, one is required, which each has the following properties. This field could help in the searchability of a product.

Field	Description	Required	Example
`productTags`	Array of translated strings of the tags	Yes	`["Home", "Outdoor"]`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`

productItemQuantity

The inventory quantity

Field	Description	Required	Example
`productId`	Variant ID	Yes	`P1001_01`
`spaceId`	Space where quantity/inventory is applicable	Yes	`<ombori generated spaceId>`
`productItemQuantityStartDate`	Quantity start date
`productItemQuantityEndDate`	Quantity end date
`productItemQuantity`	Product quantity value	Yes	`15`

productShortDescription

productShortDescription is not a required property that contains an Array of Objects, one is required, which each has the following properties.

Field	Description	Required	Example
`productShortDescription`	Translation value of the short product description	Yes	`High Quality Shirt`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`

productInternalName

productInternalName is not a required property that contains an Array of Objects, one is required, which each has the following properties.

Field	Description	Required	Example
`productInternalName`	Translation of the internal name value	Yes	`Shirt`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`

storageInstructions

storageInstructions is not a required property that contains an Array of Objects, one is required, which each has the following properties.

Field	Description	Required	Example
`storageInstructions`	Translation of the storage instructions	Yes	`Keep refrigerated`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`

consumerStorageInstruction

consumerStorageInstruction is not a required property that contains an Array of Objects, one is required, which each has the following properties.

Field	Description	Required	Example
`ConsumerStorageInstruction`	Translation of the storage instructions for the consumer	Yes	`Keep refrigerated`
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`

productShippingInstruction

productShippingInstruction is not a required property that contains an Array of Objects, one is required, which each has the following properties.

Field	Description	Required	Example
`productShippingInstruction`	Translation of the shipping instructions	Yes
`isoLanguageId`	Iso Language ID in BCP-47 format	Yes	`ISOLanguageID`