ContentDeclaration
The content declaration will hold nutritional and allergens information about an item.
The content declaration can come from different sources, and should be handled accordingly. If the content declaration is from a Recipe it might be less accurate and trustworthy than one from a Supplier.
type ContentDeclaration {
status: ContentDeclarationStatus!
parentId: String
parentType: ContentDeclarationParentType!
sourceType: ContentDeclarationSourceType!
ingredients: [KeyValuePairOfStringAndString!]
ingredientsStatement: String
nutritionalValues: [KeyValuePairOfStringAndString!]
nutrientBasisQuantity: NutrientBasisQuantity
nutrientBasisQuantityType: NutrientBasisQuantityType!
nutritionalClaimStatement: String
nutritionalClaims: [NutritionalClaimCode!]
allergenStatement: String
allergens: [KeyValuePairOfAllergenCodeAndAllergenState!]
priority: Int!
consumerUsageInstructions: String
consumerStorageInstructions: String
countryOfOrigin: String
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
ContentDeclaration.status ● ContentDeclarationStatus! non-null enum
Status of the entity.
ContentDeclaration.parentId ● String scalar
The Id for the item this content declaration applies to.
ContentDeclaration.parentType ● ContentDeclarationParentType! non-null enum
The type of parent this content declaration applies to.
ContentDeclaration.sourceType ● ContentDeclarationSourceType! non-null enum
The source of this content declaration. The content for an item can differ slightly depending on where it comes from. It is important to be able to trace this to its origin.
ContentDeclaration.ingredients ● [KeyValuePairOfStringAndString!] list object
The content in the related item. Free text field to allow customer to provide the data in their own language.
ContentDeclaration.ingredientsStatement ● String scalar
Information on the constituent ingredient make up of the product specified as one string.
ContentDeclaration.nutritionalValues ● [KeyValuePairOfStringAndString!] list object
The nutritional values of the item.
ContentDeclaration.nutrientBasisQuantity ● NutrientBasisQuantity object
Quantity on which the nutrient information has been based; for example, per 100 grams. When specified, NutrientBasisQuantity establishes the basis for all contained nutrient records.
ContentDeclaration.nutrientBasisQuantityType ● NutrientBasisQuantityType! non-null enum
The type of quantity specified in the NutrientBasisQuantity; for example, BY_MEASURE, BY_SERVING, or CONTAINER. This is used in conjunction with the NutrientBasisQuantity.
ContentDeclaration.nutritionalClaimStatement ● String scalar
Free text field for any additional nutritional claims.
ContentDeclaration.nutritionalClaims ● [NutritionalClaimCode!] list enum
Codes indicating a nutritional claim applicable to the product; for example, FAT_FREE.
ContentDeclaration.allergenStatement ● String scalar
Free text field for any additional nutritional claims.
ContentDeclaration.allergens ● [KeyValuePairOfAllergenCodeAndAllergenState!] list object
Individual description of allergens that are relevant for the item.
ContentDeclaration.priority ● Int! non-null scalar
If several content declarations exist, this will indicate how to prioritize. Some might be missing, and the lowest number should have highest priority.
ContentDeclaration.consumerUsageInstructions ● String scalar
Free text containing the usage instructions of an item, which are normally held on the label or accompanying the item. This information may or may not be labelled on the pack.
ContentDeclaration.consumerStorageInstructions ● String scalar
Expresses in text the consumer storage instructions of an item, which are normally held on the label or accompanying the item. This information may or may not be labelled on the pack.
ContentDeclaration.countryOfOrigin ● String scalar
The country or geographic area the item may have originated from or has been processed.
ContentDeclaration.additionalProperties ● [AdditionalProperty] list object
Optional dynamic list of additional information.
ContentDeclaration.globalUniqueId ● String scalar
Internal unique ID for CRUD operations and relations. A typical example is: TenantId_itemId_BusinessUnitGroupId
ContentDeclaration.id ● String scalar
Id for the entity. Either external or internal
ContentDeclaration.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.
ContentDeclaration.tenantId ● String scalar
To support multi tenancy we need to be able to identify the customer that owns this information.
ContentDeclaration.name ● String scalar
The name of the entity. This general property can replace the previous ArticleName, StoreName, CampaignName, etc.
ContentDeclaration.description ● String scalar
The description of the entity.
ContentDeclaration.businessUnitId ● String deprecated scalar
BusinessUnitId is obsolete. Use BusinessUnitIds property instead.
Used to assign the entity to tenant's specific business unit.
ContentDeclaration.businessUnitIds ● [String] list scalar
The business units associated with the entity.
ContentDeclaration.businessUnitGroupId ● String scalar
Used to assign the entity to a specific level in a business unit group hierarchy specific to the tenant.
ContentDeclaration.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.
ContentDeclaration.revision ● Long! non-null scalar
Contains evergrowing number used to validate the version of an entity.
ContentDeclaration.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.
ContentDeclaration.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.
ContentDeclaration.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.
ContentDeclaration.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
contentDeclaration query ● contentDeclarationsByParent query
Member Of
ContentDeclarationsConnection object ● ContentDeclarationsEdge object