Skip to main content

Data Platform Endpoints

For how and when to use each endpoint, see Syncing Product Data. For paging, rooms and other concepts, see the Data Platform overview.

Endpoints​

EndpointDescription
Detailed Product DataThis call is intended for an initial synchronization of all product related data or occasional updates. However, it is crucial to note that continuous usage of this endpoint is strongly discouraged
Detailed Product Data - Updated As OfThis call is intended for incremental updates.
Detailed Product Data - By Product Id ListThis call is intended to target data for a list of specific products

Detailed Product Data​

POST /dataplatform/v1/companies/{companyId}/DetailedProductData

This call is intended for an initial synchronization of all product related data or occasional updates. However, it is crucial to note that continuous usage of this endpoint is strongly discouraged

Additional Documentation​

See Initial Sync

Example of a call would be:​

POST /dataplatform/v1/Companies/{companyId}/DetailedProductData
Host: api.covasoft.net
Authorization: Bearer {your token}
Accept: application/json
Content-Type: application/json
{
"LocationId": 12346,
"IncludeProductSkusAndUpcs": true,
"IncludeProductSpecifications": true,
"IncludeClassifications": false,
"IncludeProductAssets": true,
"IncludeAvailability": true,
"IncludePackageDetails": true,
"IncludePricing": true,
"IncludeTaxes": true,
"InStockOnly": true,
"IncludeAllLifecycles": false,
"IncludeArchived": false,
"IncludeRegularPricingOnly":false,
"SellingRoomOnly": true,
"Skip": 0,
"Top": 100
}

Request Information​

URI Parameters​

NameDescriptionTypeAdditional information
companyIdintegerRequired

Body Parameters​

Properties to define which data to return.

DetailedProductDataRequestResource

NameDescriptionTypeAdditional information
LocationIdIf provided only data for the provided location will be returned. If null is provided information for all locations will be returned.integerNone.
IncludeProductSkusAndUpcsIndicates whether to include product SKUs and UPCs.booleanNone.
IncludeProductSpecificationsIndicates whether to include product specifications.booleanNone.
IncludeProductAssetsIndicates whether to include product assets.booleanNone.
IncludeAvailabilityIndicates whether to include availability data.booleanNone.
IncludePackageDetailsIndicates whether to include package details for any packages associated with the product.booleanNone.
InStockOnlyIndicates whether to only include availability data for products that have stock (Quantity > 0). Only applies if IncludeAvailability is true. NOTE: this does not exclude product details for products without stock.booleanNone.
SellingRoomOnlyIndicates whether to include product availability data for all rooms or only the default selling room. Only applies if IncludeAvailability is true.booleanNone.
IncludePricingIndicates whether to include product pricing data.booleanNone.
SkipNumber of records to skip. See Paging.integerNone.
TopNumber of records to take. See Paging.integerRange: inclusive between 1 and 500
IncludeTaxesIndicates whether to include product tax data.booleanNone.
IncludeClassificationsIndicates whether to include the canonical classification collection.booleanNone.
IncludeAllLifecyclesIndicates whether to include all lifecycles, or only Active products.booleanNone.
IncludeArchivedIndicates whether to include archived products.booleanNone.
IncludeRegularPricingOnlyIndicates whether to include all types of prices (regular, group, tier) or just regular prices. Only applies if IncludePricing is true.booleanNone.

Request Formats​

application/json, text/json

{
"LocationId": 1,
"IncludeProductSkusAndUpcs": true,
"IncludeProductSpecifications": true,
"IncludeProductAssets": true,
"IncludeAvailability": true,
"IncludePackageDetails": true,
"InStockOnly": true,
"SellingRoomOnly": true,
"IncludePricing": true,
"Skip": 9,
"Top": 10,
"IncludeTaxes": true,
"IncludeClassifications": true,
"IncludeAllLifecycles": true,
"IncludeArchived": true,
"IncludeRegularPricingOnly": true
}

Response Information​

Empty arrays in a response don't always mean there is no data; see Empty arrays.

Resource Description​

DetailedProductDataResource

NameDescriptionTypeAdditional information
ProductsCollection of DetailedProductResourceNone.
PackagesCollection of PackageResourceNone.
TaxRatesCollection of TaxRateResourceNone.
ClassificationsCollection of ClassificationResourceNone.

Response Formats​

application/json, text/json

{
"Products": [
{
"ProductId": "9f1c2b7e-4a3d-4e61-8b5a-3c7d2e1f6a90",
"MasterProductId": 67306,
"MasterProductName": "Blue Dream",
"VariationId": 2,
"Slug": "M67306-V2",
"CatalogSku": "BD3F7K2A",
"IsArchived": false,
"MeasurementType": "SingleUnit",
"IsBatchTracked": true,
"IsNonStock": false,
"LifeCycle": "Active",
"ClassificationId": 3540,
"ClassificationName": "Hybrid",
"ClassificationPath": "Flower > Hybrid",
"Name": "Blue Dream - 3.5g",
"ShortDescription": "Sweet berry aroma with a smooth, balanced finish.",
"LongDescription": "A sativa-dominant hybrid with sweet berry aromas and balanced, relaxing effects. Grown indoors and hand trimmed.",
"HeroShotAssetId": "6bb608a1-0a5e-4de6-b25e-0602edc0dc07",
"HeroShotUri": "https://amsint.iqmetrix.net/images/6bb608a1-0a5e-4de6-b25e-0602edc0dc07",
"SupplierSkus": [
{
"SKU": "GVG-BD-035",
"SupplierId": 543197,
"Supplier": "Green Valley Growers",
"Description": "Case of 10"
}
],
"ManufacturerSkus": [
{
"SKU": "BDREAM-3.5",
"Description": "Blue Dream 3.5g jar"
}
],
"Upcs": [
{
"UPC": "812345678901",
"Description": "Retail jar"
}
],
"ProductSpecifications": [
{
"FieldGroupId": "6cbad21a-7846-4fb5-98be-f846fc9497db",
"FieldGroup": "Details",
"FieldId": 2462,
"FieldName": "Brand",
"StringId": "Brand",
"DisplayName": "Brand",
"Value": "Green Valley",
"Type": "TextSingleLine",
"Unit": ""
},
{
"FieldGroupId": "6cbad21a-7846-4fb5-98be-f846fc9497db",
"FieldGroup": "Details",
"FieldId": 1851,
"FieldName": "Retail Marijuana Product Type - Canada",
"StringId": "Retail Marijuana Product Type - Canada",
"DisplayName": "Retail Marijuana Product Type - Canada",
"Value": "Dried Cannabis",
"Type": "SingleSelect",
"Unit": ""
},
{
"FieldGroupId": "5cb272bf-44ba-4928-a550-1ea02bbfc0ff",
"FieldGroup": "Other",
"FieldId": 2548,
"FieldName": "THC %",
"StringId": "THC %",
"DisplayName": "THC %",
"Value": "22.5",
"Type": "Float",
"Unit": ""
},
{
"FieldGroupId": "5cb272bf-44ba-4928-a550-1ea02bbfc0ff",
"FieldGroup": "Other",
"FieldId": 1873,
"FieldName": "Net Weight",
"StringId": "Net Weight",
"DisplayName": "Net Weight",
"Value": "3.5",
"Type": "Float",
"Unit": "g"
},
{
"FieldGroupId": "5cb272bf-44ba-4928-a550-1ea02bbfc0ff",
"FieldGroup": "Other",
"FieldId": 1856,
"FieldName": "Strain",
"StringId": "Strain",
"DisplayName": "Strain",
"Value": "Blue Dream",
"Type": "TextSingleLine",
"Unit": ""
},
{
"FieldGroupId": "5cb272bf-44ba-4928-a550-1ea02bbfc0ff",
"FieldGroup": "Other",
"FieldId": 2330,
"FieldName": "Online Menu Tags",
"StringId": "Online Menu Tags",
"DisplayName": "Online Menu Tags",
"Value": "Relaxing, Berry",
"Type": "MultiSelect",
"Unit": ""
}
],
"Assets": [
{
"Id": "6bb608a1-0a5e-4de6-b25e-0602edc0dc07",
"Name": "blue-dream-jar.png",
"Uri": "https://amsint.iqmetrix.net/images/6bb608a1-0a5e-4de6-b25e-0602edc0dc07",
"Type": "Image",
"IsHidden": false
},
{
"Id": "c41d7e52-93f0-4b8a-a6d1-2e5f8b0c7a13",
"Name": "blue-dream-bud.png",
"Uri": "https://amsint.iqmetrix.net/images/c41d7e52-93f0-4b8a-a6d1-2e5f8b0c7a13",
"Type": "Image",
"IsHidden": false
}
],
"Availability": [
{
"LocationId": 539010,
"RoomId": 184,
"PackageId": "10012032",
"BatchId": "BD-2026-114",
"UnitId": 0,
"InStockQuantity": 24,
"OnOrderQuantity": 0,
"TransferInQuantity": 0,
"TransferOutQuantity": 2,
"OnHoldQuantity": 1,
"TotalCostInStock": 480.0,
"UnitCost": 20.0,
"ReceivedDate": "2026-02-10T18:30:00.000Z",
"UpdatedDateUtc": "2026-10-28T14:12:45.3120000Z",
"IsSellingRoom": true,
"FirstReceivedDateUtc": "2025-08-19T16:05:11.2400000Z"
},
{
"LocationId": 539010,
"RoomId": 185,
"PackageId": "10012032",
"BatchId": "BD-2026-114",
"UnitId": 0,
"InStockQuantity": 60,
"OnOrderQuantity": 0,
"TransferInQuantity": 0,
"TransferOutQuantity": 0,
"OnHoldQuantity": 0,
"TotalCostInStock": 1200.0,
"UnitCost": 20.0,
"ReceivedDate": "2026-02-10T18:30:00.000Z",
"UpdatedDateUtc": "2026-10-28T14:12:45.3120000Z",
"IsSellingRoom": false,
"FirstReceivedDateUtc": "2025-08-19T16:05:11.2400000Z"
}
],
"Prices": [
{
"LocationId": 539010,
"FromEntityId": 539009,
"ProductId": "9f1c2b7e-4a3d-4e61-8b5a-3c7d2e1f6a90",
"TierId": null,
"TierName": null,
"TierQuantity": null,
"AtTierPriceAppliesUpTo": null,
"GroupId": null,
"GroupName": null,
"ShelfId": null,
"ShelfName": null,
"Price": 35.0,
"AtTierPrice": null,
"SalePrices": [
{
"SalePrice": 29.99,
"AtTierSalePrice": null,
"StartDateUtc": "2026-11-20T08:00:00.0000000Z",
"StopDateUtc": "2026-11-30T07:59:59.0000000Z"
}
],
"UpdatedDateUtc": "2026-10-15T19:03:27.5400000Z"
},
{
"LocationId": 539010,
"FromEntityId": 539009,
"ProductId": "9f1c2b7e-4a3d-4e61-8b5a-3c7d2e1f6a90",
"TierId": 41,
"TierName": "Buy 3 or more",
"TierQuantity": 3,
"AtTierPriceAppliesUpTo": null,
"GroupId": null,
"GroupName": null,
"ShelfId": null,
"ShelfName": null,
"Price": 35.0,
"AtTierPrice": 32.0,
"SalePrices": [],
"UpdatedDateUtc": "2026-10-15T19:03:27.5400000Z"
},
{
"LocationId": 539345,
"FromEntityId": 539009,
"ProductId": "9f1c2b7e-4a3d-4e61-8b5a-3c7d2e1f6a90",
"TierId": null,
"TierName": null,
"TierQuantity": null,
"AtTierPriceAppliesUpTo": null,
"GroupId": null,
"GroupName": null,
"ShelfId": null,
"ShelfName": null,
"Price": 36.0,
"AtTierPrice": null,
"SalePrices": [],
"UpdatedDateUtc": "2026-09-02T13:41:09.1100000Z"
}
],
"CreatedDateUtc": "2025-08-19T15:58:02.4417091Z",
"UpdatedDateUtc": "2026-10-15T19:03:27.5400000Z",
"ApplicableTaxRates": [
"0bad3d74-b4f2-457b-a0a1-22c31eab00ad",
"5e7a1c90-2b4f-4d86-9a3e-7c1f0d8b6e24"
],
"ClassificationTreeId": 3539,
"ManufacturerId": 543197,
"Manufacturer": "Green Valley Growers",
"MSRP": 39.99,
"MSRPCurrencyCode": "CAD",
"CompanyLevelRegularPrice": {
"Price": 35.0,
"SalePrices": [
{
"SalePrice": 29.99,
"StartDateUtc": "2026-11-20T08:00:00.0000000Z",
"StopDateUtc": "2026-11-30T07:59:59.0000000Z"
}
]
}
},
{
"ProductId": "36583121-1eec-4312-b44f-0416c3e435ef",
"MasterProductId": 82187,
"MasterProductName": "Delivery Fee",
"VariationId": null,
"Slug": "M82187",
"CatalogSku": "0YUPUEQA",
"IsArchived": false,
"MeasurementType": "SingleUnit",
"IsBatchTracked": false,
"IsNonStock": true,
"LifeCycle": "Active",
"ClassificationId": 3545,
"ClassificationName": "Services",
"ClassificationPath": "Services",
"Name": "Delivery Fee",
"ShortDescription": "Flat-rate local delivery",
"LongDescription": "",
"HeroShotAssetId": null,
"HeroShotUri": null,
"SupplierSkus": [],
"ManufacturerSkus": [],
"Upcs": [],
"ProductSpecifications": [],
"Assets": [],
"Availability": [],
"Prices": [
{
"LocationId": 539010,
"FromEntityId": 539009,
"ProductId": "36583121-1eec-4312-b44f-0416c3e435ef",
"TierId": null,
"TierName": null,
"TierQuantity": null,
"AtTierPriceAppliesUpTo": null,
"GroupId": null,
"GroupName": null,
"ShelfId": null,
"ShelfName": null,
"Price": 5.0,
"AtTierPrice": null,
"SalePrices": [],
"UpdatedDateUtc": "2026-03-04T17:22:10.0000000Z"
}
],
"CreatedDateUtc": "2026-03-04T17:20:44.1200000Z",
"UpdatedDateUtc": "2026-03-04T17:22:10.0000000Z",
"ApplicableTaxRates": [],
"ClassificationTreeId": 3539,
"ManufacturerId": null,
"Manufacturer": null,
"MSRP": null,
"MSRPCurrencyCode": null,
"CompanyLevelRegularPrice": null
}
],
"Packages": [
{
"ProductsAssociatedWith": [
"9f1c2b7e-4a3d-4e61-8b5a-3c7d2e1f6a90"
],
"PackageId": "10012032",
"BatchId": "BD-2026-114",
"ExpiryDate": "2027-02-10T00:00:00",
"UseByDate": null,
"Strain": "Blue Dream",
"SupplierLicense": "LIC-0045821",
"TestDate": "2026-01-20T00:00:00",
"HarvestDate": "2025-12-18T00:00:00",
"TestingFacilityName": "Northern Labs",
"TestBatchNumber": "NL-88213",
"SupplierName": "Green Valley Growers",
"SupplierId": 543197,
"TerpeneProfile": "Myrcene, Pinene, Caryophyllene",
"ReceivingId": "d2a6f3b1-7c48-4e95-b0a2-19e8c5d47f36",
"ReceivingDate": "2026-02-10T18:15:28.667",
"Cannabinoids": [
{
"CannabinoidType": "THC",
"MeasurementType": "Percent",
"MinValue": 21.8,
"MaxValue": 22.5
},
{
"CannabinoidType": "CBD",
"MeasurementType": "Percent",
"MinValue": 0.1,
"MaxValue": 0.1
}
],
"PackagedDate": "2026-01-28T00:00:00",
"ProductionDate": "2025-12-30T00:00:00",
"CreatedDateUtc": "2026-02-10T18:15:30.4307016",
"UpdatedDateUtc": "2026-02-10T18:15:30.4307016",
"ParentPackageId": null,
"RetailIdRanges": [
{
"RangeStart": 1001,
"RangeEnd": 1024,
"CreatedDateUtc": "2026-02-10T18:20:03.1200000"
}
],
"Url": null,
"IsArchived": false,
"IsArchivedChangedDateUtc": null,
"IsArchivedChangedBy": null
}
],
"TaxRates": [
{
"Id": "0bad3d74-b4f2-457b-a0a1-22c31eab00ad",
"Name": "PST",
"DisplayName": "PST",
"Type": "Percentage",
"Rate": 0.06,
"Layer": 0,
"CalculatedOn": "SoldAtPrice",
"Locations": [
539010,
539345
]
},
{
"Id": "5e7a1c90-2b4f-4d86-9a3e-7c1f0d8b6e24",
"Name": "GST",
"DisplayName": "GST",
"Type": "Percentage",
"Rate": 0.05,
"Layer": 0,
"CalculatedOn": "SoldAtPrice",
"Locations": [
539010,
539345
]
}
],
"Classifications": [
{
"TreeId": 3539,
"Id": 3540,
"Name": "Hybrid",
"ParentCategories": [
{
"Id": 3560,
"Name": "Flower"
}
]
},
{
"TreeId": 3539,
"Id": 3545,
"Name": "Services",
"ParentCategories": []
}
]
}

Detailed Product Data - Updated As Of​

POST /dataplatform/v1/companies/{companyId}/DetailedProductData/UpdatedAsOf/{updatedAsOfUTC}

This call is intended for incremental updates.

Additional Documentation​

See Incremental Sync

Example of a call would be:​

POST /dataplatform/v1/Companies/{companyId}/DetailedProductData/UpdatedAsOf/{updatedAsOfUtc}
Host: api.covasoft.net
Authorization: Bearer {your token}
Accept: application/json
Content-Type: application/json
{
"LocationId": 12346,
"IncludeProductSkusAndUpcs": true,
"IncludeProductSpecifications": true,
"IncludeClassifications": false,
"IncludeProductAssets": true,
"IncludeAvailability": true,
"IncludePackageDetails": true,
"IncludePricing": true,
"IncludeTaxes": true,
"InStockOnly": false,
"IncludeAllLifecycles": false,
"IncludeArchived": false,
"IncludeRegularPricingOnly":false,
"SellingRoomOnly": true,
"Skip": 0,
"Top": 100
}

Request Information​

URI Parameters​

NameDescriptionTypeAdditional information
companyIdintegerRequired
updatedAsOfUTCdateRequired

Body Parameters​

Same as Detailed Product Data, including the request body example.

Response Information​

Same DetailedProductDataResource response as Detailed Product Data, including the response example. Models are listed under Models.

Detailed Product Data - By Product Id List​

POST /dataplatform/v1/companies/{companyId}/DetailedProductData/ByProductIdList

This call is intended to target data for a list of specific products

Additional Documentation​

See Targeted Sync

Example of a call would be:​

POST /dataplatform/v1/Companies/{companyId}/DetailedProductData/ByProductIdList
Host: api.covasoft.net
Authorization: Bearer {your token}
Accept: application/json
Content-Type: application/json
{
"LocationId": 12346,
"IncludeProductSkusAndUpcs": true,
"IncludeProductSpecifications": true,
"IncludeClassifications": false,
"IncludeProductAssets": true,
"IncludeAvailability": true,
"IncludePackageDetails": true,
"IncludePricing": true,
"IncludeTaxes": true,
"InStockOnly": false,
"IncludeAllLifecycles": false,
"IncludeArchived": false,
"IncludeRegularPricingOnly":false,
"SellingRoomOnly": true,
"ProductIds": [
"f422615b-c5d7-457b-ac18-9d839be9372c",
"23BE37FD-DDBE-4563-8B78-FEE21665E2ED"
]
}

Request Information​

URI Parameters​

NameDescriptionTypeAdditional information
companyIdintegerRequired

Body Parameters​

Properties to define which data to return.

DetailedProductDataByProductIdListRequestResource

NameDescriptionTypeAdditional information
LocationIdIf provided only data for the provided location will be returned. If null is provided information for all locations will be returned.integerNone.
ProductIdsList of Product Id's to get data for.Collection of globally unique identifierNone.
IncludeProductSkusAndUpcsIndicates whether to include product SKUs and UPCs.booleanNone.
IncludeProductSpecificationsIndicates whether to include product specifications.booleanNone.
IncludeProductAssetsIndicates whether to include product assets.booleanNone.
IncludeAvailabilityIndicates whether to include availability data.booleanNone.
IncludePackageDetailsIndicates whether to include package details for any packages associated with the product.booleanNone.
InStockOnlyIndicates whether to only include products/packages that have stock. Only applies if IncludeAvailability is true.booleanNone.
SellingRoomOnlyIndicates whether to include products availability data for all rooms or only the default selling room. Only applies if IncludeAvailability is true.booleanNone.
IncludePricingIndicates whether to include product pricing data.booleanNone.
IncludeTaxesIndicates whether to include product tax data.booleanNone.
IncludeClassificationsIndicates whether to include the canonical classification collection.booleanNone.
IncludeAllLifecyclesIndicates whether to include all lifecycles, or only Active products.booleanNone.
IncludeArchivedIndicates whether to include archived products.booleanNone.
IncludeRegularPricingOnlyIndicates whether to include all types of prices (regular, group, tier) or just regular prices. Only applies if IncludePricing is true.booleanNone.

Request Formats​

application/json, text/json

{
"LocationId": 1,
"ProductIds": [
"73576a97-df38-4eb7-adda-c783ff797da4",
"16dcd2ba-b593-4f5d-85d2-1d2a0696eaa8"
],
"IncludeProductSkusAndUpcs": true,
"IncludeProductSpecifications": true,
"IncludeProductAssets": true,
"IncludeAvailability": true,
"IncludePackageDetails": true,
"InStockOnly": true,
"SellingRoomOnly": true,
"IncludePricing": true,
"IncludeTaxes": true,
"IncludeClassifications": true,
"IncludeAllLifecycles": true,
"IncludeArchived": true,
"IncludeRegularPricingOnly": true
}

Response Information​

Same DetailedProductDataResource response as Detailed Product Data, including the response example. Models are listed under Models.

Models​

Resource models returned by all three endpoints.

DetailedProductResource
NameDescriptionTypeAdditional information
ProductIdUsed throughout Cova as the main identifier for a productglobally unique identifierNone.
MasterProductIdInternally generated identifier. A master product may have variants. For example, a 'Blue Shirt' master may have variants for Small, Medium, and LargeintegerNone.
MasterProductNameName of the master product group. i.e. 'Blue Shirt' from the example abovestringNone.
VariationIdIdentifier of the variant under a master. Nullable if the master has no variants.integerNone.
SlugCombination of previous identifiers: 'M{MasterProductId}-V{VariationId}' example: 'M105548-V4'stringNone.
CatalogSkuGenerated searchable identifier on Cova Hub and POS AppstringNone.
IsArchivedAn archived product is a deleted product that should be hidden from consumersbooleanNone.
MeasurementTypeEstablishes how a product is sold; a single unit (each) or by weight (grams). Valid values:'SingleUnit' or 'Mass'stringNone.
IsBatchTrackedIndicates whether the product requires a PackageId, an identifier controlled by a governing body (METRC, OCS, etc).booleanNone.
IsNonStockNot a physical product. For example, a delivery feebooleanNone.
LifeCycleValid values: Active, Coming Soon, Inactive, Discontinued, Archived. Only 'Active' products should be displayed to consumers for salestringNone.
ClassificationIdClassification identifier.integerNone.
ClassificationNameClassification NamestringNone.
ClassificationPathPath from the top level of the retailer classification tree. Example: Flower > IndicastringNone.
NameProduct namestringNone.
ShortDescriptionA brief product descriptionstringNone.
LongDescriptionA detailed product descriptionstringNone.
HeroShotAssetIdIdentifier of the main asset (image) Nullableglobally unique identifierNone.
HeroShotUriURI for the main asset (image)stringNone.
SupplierSkusCollection of SupplierSkuResourceNone.
ManufacturerSkusCollection of ManufacturerSkuResourceNone.
UpcsCollection of UpcResourceNone.
ProductSpecificationsCollection of SpecificationResourceNone.
AssetsCollection of AssetResourceNone.
AvailabilityCollection of AvailabilityResourceNone.
PricesCollection of PriceResourceNone.
CreatedDateUtcUTC datetime of when the product record was addeddateNone.
UpdatedDateUtcUTC datetime of the last time the product record was modifieddateNone.
ApplicableTaxRatesTax rate identifiers that may be applicable for this productCollection of globally unique identifierNone.
ClassificationTreeIdIdentifier of the classification treeintegerNone.
ManufacturerIdID of the manufacturer of the productintegerNone.
ManufacturerName of the ManufacturerstringNone.
MSRPManufacturer suggested retail pricedecimal numberNone.
MSRPCurrencyCodeManufacturer suggested retail price currency codestringNone.
CompanyLevelRegularPriceThe regular price set at the company level, if there is one set.CompanyLevelRegularPriceResourceNone.
PackageResource

Represents the details entered for a package when it was received.

NameDescriptionTypeAdditional information
ProductsAssociatedWithCollection of product identifiers where this package is referenced.Collection of globally unique identifierNone.
PackageIdThe package identifier.stringNone.
BatchIdThe batch identifier.stringNone.
ExpiryDateExpiry date of the package.dateNone.
UseByDateUse By date of the package.dateNone.
StrainThe package strain.stringNone.
SupplierLicenseThe suppliers license number.stringNone.
TestDateThe date the package was tested.dateNone.
HarvestDateThe date the package was harvested.dateNone.
TestingFacilityNameName of the facility where the package was tested.stringNone.
TestBatchNumberBatch number associated with test.stringNone.
SupplierNameName of the supplier of the package.stringNone.
SupplierIdEntity Id of the supplier of the package.integerNone.
TerpeneProfileTerpene profile.stringNone.
ReceivingIdUnique identifier of the PO the package was received on.globally unique identifierNone.
ReceivingDateDate that the package was received in store local time.dateNone.
CannabinoidsCollection of cannabinoids associated with the product.Collection of CannabinoidResourceNone.
PackagedDateThe date the product was packaged.dateNone.
ProductionDateThe date the product was produced.dateNone.
CreatedDateUtcThe date the package was created.dateNone.
UpdatedDateUtcThe date the package was last updated.dateNone.
ParentPackageIdThe parent package identifier.stringNone.
RetailIdRangesCollection of retail ids associated with the package.Collection of RetailIdRangeResourceNone.
UrlUrl associated with the package.stringNone.
IsArchivedIndicates whether the package is archived.booleanNone.
IsArchivedChangedDateUtcThe date the package archived status was last changed.dateNone.
IsArchivedChangedByThe entity id of the user who last changed the package archived status.integerNone.
TaxRateResource
NameDescriptionTypeAdditional information
IdUnique identifier for the tax rate.globally unique identifierNone.
NameThe name of the tax rate.stringNone.
DisplayNameThe display name of the tax rate.stringNone.
TypeThe type of tax, percentage or flat rate such as a bottle deposit or environmental handling fee.stringNone.
RateThe tax rate. For Percentage type, this is a decimal. (8% tax = .08). Flat Rate is a dollar amount (50 cent deposit = 0.50)decimal numberNone.
LayerIdentifies if the tax is compounding: 0 = non-compounding, 1 = Compounds on non-compound taxes (Level 2), 2 = Compounds after all other taxes (Level 3)integerNone.
CalculatedOnIndicates whether the tax is calculated on the base price or the sold at price.stringNone.
LocationsCollection of integerNone.
ClassificationResource
NameDescriptionTypeAdditional information
TreeIdClassification tree identifierintegerNone.
IdClassification identifierintegerNone.
NameClassification namestringNone.
ParentCategoriesList of parent categories in the product tree in the order they appear in Cova HubCollection of CategoryItemNone.
SupplierSkuResource

Represents a supplier SKU associated with a product.

NameDescriptionTypeAdditional information
SKUSupplier SKU.stringNone.
SupplierIdID of the supplier associated with the SKU. NullableintegerNone.
SupplierName of the supplier associated with the SKU.stringNone.
DescriptionDescription associated with the supplier SKU.stringNone.
ManufacturerSkuResource

Represents a manufacturer SKU associated with a product.

NameDescriptionTypeAdditional information
SKUManufacturer SKU.stringNone.
DescriptionDescription associated with the manufacturer SKU.stringNone.
UpcResource

Represents a UPC associated with a product.

NameDescriptionTypeAdditional information
UPCstringNone.
DescriptionDescription associated with the UPC.stringNone.
SpecificationResource

Represents a specification associated with a product.

NameDescriptionTypeAdditional information
FieldGroupIdThe ID of the group the specification belongs to.globally unique identifierNone.
FieldGroupThe group the specification belongs to. Example: DetailsstringNone.
FieldIdThe ID of the specification.integerNone.
FieldNameThe name of the specification. Example: Retail Marijuana Product TypestringNone.
StringIdThe string id of the specification.stringNone.
DisplayNameThe display name of the specification. Example: Retail Marijuana Product Type. Use this value to find particular specification fieldsstringNone.
ValueThe value that is set for the field. Comma delimited for 'MultiSelect' type fieldsstringNone.
TypeThe type of specification in relation to Cova Hub controls. Valid values: 'TextSingleLine','SingleSelect','MultiSelect','Float','TextMultipleLine','YesNo'stringNone.
UnitThe unit the value is measured in if applicable. Example: g, ozstringNone.
AssetResource

Product asset resource.

NameDescriptionTypeAdditional information
IdUnique identifier of the asset.globally unique identifierNone.
NameAsset name.stringNone.
UriUri to the asset.stringNone.
TypeAsset type.stringNone.
IsHiddenIndicates if the asset is hidden.booleanNone.
AvailabilityResource
NameDescriptionTypeAdditional information
LocationIdLocation (store) identifier where this product existsintegerNone.
RoomIdRoom identifier within a location. For example "Receiving Room" or "Sales Floor"integerNone.
PackageIdIdentifier typically controlled by a governing body (METRC, OCS, etc)stringNone.
BatchIdAdditional package tracking informationstringNone.
UnitIdInternal identifier for the unit of measure. i.e. 0 is 'Single Unit'. 103 is gram, 110 is milligramintegerNone.
InStockQuantityQuantity of this product in stock, at this location, in this room.decimal numberNone.
OnOrderQuantityQuantity of this product on order. This is at the product level, not the package level, so it is the same for all packages of a product (product on order does not have a PackageId assigned yet)decimal numberNone.
TransferInQuantityQuantity of this product on an incoming transferdecimal numberNone.
TransferOutQuantityQuantity of this product on an outgoing transferdecimal numberNone.
OnHoldQuantityThe amount currently on hold in display units.decimal numberNone.
TotalCostInStockThe retailer's total cost of these productsdecimal numberNone.
UnitCostThe retailer's per-unit cost for these productsdecimal numberNone.
ReceivedDateUTC datetime of when these products were received into inventorydateNone.
UpdatedDateUtcUTC datetime of when this record was last updated (i.e. quantity changed, etc).dateNone.
IsSellingRoomIndicates if the room this inventory is in the default selling room.booleanNone.
FirstReceivedDateUtcThe UTC datetime representing the first instance the product was available at this location, agnostic of PackageId. NOTE: This is different from ReceivedDate which indicates when a specific package was receiveddateNone.
PriceResource
NameDescriptionTypeAdditional information
LocationIdLocation (store) identifier where this price is validintegerNone.
FromEntityIdThe entity where the price is inherited fromintegerNone.
ProductIdUsed throughout Cova as the main identifier for a productglobally unique identifierNone.
TierIdTier identifier, if this product is priced in tiers. Example of tiers: 2 or fewer for $5 each; 3 to 5 for $4 each; 6 or more for $3 each Nullable if not a tiered priceintegerNone.
TierNameName of the tier, if applicablestringNone.
TierQuantityMinimum quantity to qualify for the tier price Nullable if not a tiered pricedecimal numberNone.
AtTierPriceAppliesUpToFor weigh heavy pricing, the maximum quantity to qualify for the AtTierPrice Nullable if not a tiered price or the tier does not use weigh heavy pricingdecimal numberNone.
GroupIdIdentifier of a pricing group, if applicableintegerNone.
GroupNameName of the pricing group. For example: Veterans, Employees Nullable if not a group pricestringNone.
ShelfIdIdentifier of a pricing shelf, if applicable. A Shelf is a way to apply common pricing to multiple products. For example, all products on the "Top Shelf" are $10.integerNone.
ShelfNameName of the pricing shelf, if applicable Nullable if not a shelf pricestringNone.
PriceRegular price for this productdecimal numberNone.
AtTierPricePrice for this product at the lower bound (TierQuantity) or quantity range (TierQuantity - AtTierPriceAppliesUpTo if the tier uses weigh heavy pricing). Always use this price when calculating totals for tiered products. Nullable if not a tiered pricedecimal numberNone.
SalePricesCollection of SalePriceResourceNone.
UpdatedDateUtcThe UTC datetime this pricing record was last modifieddateNone.
CompanyLevelRegularPriceResource
NameDescriptionTypeAdditional information
PriceThe regular price set at the company level for this productdecimal numberNone.
SalePricesCollection of sale prices set on the regular price at the company levelCollection of CompanyLevelRegularSalePriceResourceNone.
CannabinoidResource
NameDescriptionTypeAdditional information
CannabinoidTypeThe cannabinoid. Example: THC, CBDstringNone.
MeasurementTypeHow the cannabinoid is measured. Example: percent, mgstringNone.
MinValueThe minimum value entered for the cannabinoid.decimal numberNone.
MaxValueThe maximum value entered for the cannabinoid.decimal numberNone.
RetailIdRangeResource
NameDescriptionTypeAdditional information
RangeStartStarting id of the range of retail ids.integerNone.
RangeEndEnding id of the range of retail ids.integerNone.
CreatedDateUtcThe date the retail id range was created.dateNone.
CategoryItem
NameDescriptionTypeAdditional information
IdintegerNone.
NamestringNone.
SalePriceResource
NameDescriptionTypeAdditional information
SalePriceThe sale price for this productdecimal numberNone.
AtTierSalePriceSale Price for this product at the lower bound (TierQuantity). Always use this price when calculating totals for tiered products. Nullable if not a tiered pricedecimal numberNone.
StartDateUtcUTC datetime for when the sale begins NullabledateNone.
StopDateUtcUTC datetime for when the sale ends NullabledateNone.
CompanyLevelRegularSalePriceResource
NameDescriptionTypeAdditional information
SalePriceThe company level regular sale price for this productdecimal numberNone.
StartDateUtcUTC datetime for when the sale begins NullabledateNone.
StopDateUtcUTC datetime for when the sale ends NullabledateNone.