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
| Endpoint | Description |
|---|---|
| Detailed Product Data | 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 |
| Detailed Product Data - Updated As Of | This call is intended for incremental updates. |
| Detailed Product Data - By Product Id List | This 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
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyId | integer | Required |
Body Parameters
Properties to define which data to return.
DetailedProductDataRequestResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationId | If provided only data for the provided location will be returned. If null is provided information for all locations will be returned. | integer | None. |
| IncludeProductSkusAndUpcs | Indicates whether to include product SKUs and UPCs. | boolean | None. |
| IncludeProductSpecifications | Indicates whether to include product specifications. | boolean | None. |
| IncludeProductAssets | Indicates whether to include product assets. | boolean | None. |
| IncludeAvailability | Indicates whether to include availability data. | boolean | None. |
| IncludePackageDetails | Indicates whether to include package details for any packages associated with the product. | boolean | None. |
| InStockOnly | Indicates 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. | boolean | None. |
| SellingRoomOnly | Indicates whether to include product availability data for all rooms or only the default selling room. Only applies if IncludeAvailability is true. | boolean | None. |
| IncludePricing | Indicates whether to include product pricing data. | boolean | None. |
| Skip | Number of records to skip. See Paging. | integer | None. |
| Top | Number of records to take. See Paging. | integer | Range: inclusive between 1 and 500 |
| IncludeTaxes | Indicates whether to include product tax data. | boolean | None. |
| IncludeClassifications | Indicates whether to include the canonical classification collection. | boolean | None. |
| IncludeAllLifecycles | Indicates whether to include all lifecycles, or only Active products. | boolean | None. |
| IncludeArchived | Indicates whether to include archived products. | boolean | None. |
| IncludeRegularPricingOnly | Indicates whether to include all types of prices (regular, group, tier) or just regular prices. Only applies if IncludePricing is true. | boolean | None. |
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
| Name | Description | Type | Additional information |
|---|---|---|---|
| Products | Collection of DetailedProductResource | None. | |
| Packages | Collection of PackageResource | None. | |
| TaxRates | Collection of TaxRateResource | None. | |
| Classifications | Collection of ClassificationResource | None. |
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
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyId | integer | Required | |
| updatedAsOfUTC | date | Required |
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
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyId | integer | Required |
Body Parameters
Properties to define which data to return.
DetailedProductDataByProductIdListRequestResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationId | If provided only data for the provided location will be returned. If null is provided information for all locations will be returned. | integer | None. |
| ProductIds | List of Product Id's to get data for. | Collection of globally unique identifier | None. |
| IncludeProductSkusAndUpcs | Indicates whether to include product SKUs and UPCs. | boolean | None. |
| IncludeProductSpecifications | Indicates whether to include product specifications. | boolean | None. |
| IncludeProductAssets | Indicates whether to include product assets. | boolean | None. |
| IncludeAvailability | Indicates whether to include availability data. | boolean | None. |
| IncludePackageDetails | Indicates whether to include package details for any packages associated with the product. | boolean | None. |
| InStockOnly | Indicates whether to only include products/packages that have stock. Only applies if IncludeAvailability is true. | boolean | None. |
| SellingRoomOnly | Indicates whether to include products availability data for all rooms or only the default selling room. Only applies if IncludeAvailability is true. | boolean | None. |
| IncludePricing | Indicates whether to include product pricing data. | boolean | None. |
| IncludeTaxes | Indicates whether to include product tax data. | boolean | None. |
| IncludeClassifications | Indicates whether to include the canonical classification collection. | boolean | None. |
| IncludeAllLifecycles | Indicates whether to include all lifecycles, or only Active products. | boolean | None. |
| IncludeArchived | Indicates whether to include archived products. | boolean | None. |
| IncludeRegularPricingOnly | Indicates whether to include all types of prices (regular, group, tier) or just regular prices. Only applies if IncludePricing is true. | boolean | None. |
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
| Name | Description | Type | Additional information |
|---|---|---|---|
| ProductId | Used throughout Cova as the main identifier for a product | globally unique identifier | None. |
| MasterProductId | Internally generated identifier. A master product may have variants. For example, a 'Blue Shirt' master may have variants for Small, Medium, and Large | integer | None. |
| MasterProductName | Name of the master product group. i.e. 'Blue Shirt' from the example above | string | None. |
| VariationId | Identifier of the variant under a master. Nullable if the master has no variants. | integer | None. |
| Slug | Combination of previous identifiers: 'M{MasterProductId}-V{VariationId}' example: 'M105548-V4' | string | None. |
| CatalogSku | Generated searchable identifier on Cova Hub and POS App | string | None. |
| IsArchived | An archived product is a deleted product that should be hidden from consumers | boolean | None. |
| MeasurementType | Establishes how a product is sold; a single unit (each) or by weight (grams). Valid values:'SingleUnit' or 'Mass' | string | None. |
| IsBatchTracked | Indicates whether the product requires a PackageId, an identifier controlled by a governing body (METRC, OCS, etc). | boolean | None. |
| IsNonStock | Not a physical product. For example, a delivery fee | boolean | None. |
| LifeCycle | Valid values: Active, Coming Soon, Inactive, Discontinued, Archived. Only 'Active' products should be displayed to consumers for sale | string | None. |
| ClassificationId | Classification identifier. | integer | None. |
| ClassificationName | Classification Name | string | None. |
| ClassificationPath | Path from the top level of the retailer classification tree. Example: Flower > Indica | string | None. |
| Name | Product name | string | None. |
| ShortDescription | A brief product description | string | None. |
| LongDescription | A detailed product description | string | None. |
| HeroShotAssetId | Identifier of the main asset (image) Nullable | globally unique identifier | None. |
| HeroShotUri | URI for the main asset (image) | string | None. |
| SupplierSkus | Collection of SupplierSkuResource | None. | |
| ManufacturerSkus | Collection of ManufacturerSkuResource | None. | |
| Upcs | Collection of UpcResource | None. | |
| ProductSpecifications | Collection of SpecificationResource | None. | |
| Assets | Collection of AssetResource | None. | |
| Availability | Collection of AvailabilityResource | None. | |
| Prices | Collection of PriceResource | None. | |
| CreatedDateUtc | UTC datetime of when the product record was added | date | None. |
| UpdatedDateUtc | UTC datetime of the last time the product record was modified | date | None. |
| ApplicableTaxRates | Tax rate identifiers that may be applicable for this product | Collection of globally unique identifier | None. |
| ClassificationTreeId | Identifier of the classification tree | integer | None. |
| ManufacturerId | ID of the manufacturer of the product | integer | None. |
| Manufacturer | Name of the Manufacturer | string | None. |
| MSRP | Manufacturer suggested retail price | decimal number | None. |
| MSRPCurrencyCode | Manufacturer suggested retail price currency code | string | None. |
| CompanyLevelRegularPrice | The regular price set at the company level, if there is one set. | CompanyLevelRegularPriceResource | None. |
PackageResource
Represents the details entered for a package when it was received.
| Name | Description | Type | Additional information |
|---|---|---|---|
| ProductsAssociatedWith | Collection of product identifiers where this package is referenced. | Collection of globally unique identifier | None. |
| PackageId | The package identifier. | string | None. |
| BatchId | The batch identifier. | string | None. |
| ExpiryDate | Expiry date of the package. | date | None. |
| UseByDate | Use By date of the package. | date | None. |
| Strain | The package strain. | string | None. |
| SupplierLicense | The suppliers license number. | string | None. |
| TestDate | The date the package was tested. | date | None. |
| HarvestDate | The date the package was harvested. | date | None. |
| TestingFacilityName | Name of the facility where the package was tested. | string | None. |
| TestBatchNumber | Batch number associated with test. | string | None. |
| SupplierName | Name of the supplier of the package. | string | None. |
| SupplierId | Entity Id of the supplier of the package. | integer | None. |
| TerpeneProfile | Terpene profile. | string | None. |
| ReceivingId | Unique identifier of the PO the package was received on. | globally unique identifier | None. |
| ReceivingDate | Date that the package was received in store local time. | date | None. |
| Cannabinoids | Collection of cannabinoids associated with the product. | Collection of CannabinoidResource | None. |
| PackagedDate | The date the product was packaged. | date | None. |
| ProductionDate | The date the product was produced. | date | None. |
| CreatedDateUtc | The date the package was created. | date | None. |
| UpdatedDateUtc | The date the package was last updated. | date | None. |
| ParentPackageId | The parent package identifier. | string | None. |
| RetailIdRanges | Collection of retail ids associated with the package. | Collection of RetailIdRangeResource | None. |
| Url | Url associated with the package. | string | None. |
| IsArchived | Indicates whether the package is archived. | boolean | None. |
| IsArchivedChangedDateUtc | The date the package archived status was last changed. | date | None. |
| IsArchivedChangedBy | The entity id of the user who last changed the package archived status. | integer | None. |
TaxRateResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | Unique identifier for the tax rate. | globally unique identifier | None. |
| Name | The name of the tax rate. | string | None. |
| DisplayName | The display name of the tax rate. | string | None. |
| Type | The type of tax, percentage or flat rate such as a bottle deposit or environmental handling fee. | string | None. |
| Rate | The tax rate. For Percentage type, this is a decimal. (8% tax = .08). Flat Rate is a dollar amount (50 cent deposit = 0.50) | decimal number | None. |
| Layer | Identifies if the tax is compounding: 0 = non-compounding, 1 = Compounds on non-compound taxes (Level 2), 2 = Compounds after all other taxes (Level 3) | integer | None. |
| CalculatedOn | Indicates whether the tax is calculated on the base price or the sold at price. | string | None. |
| Locations | Collection of integer | None. |
ClassificationResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| TreeId | Classification tree identifier | integer | None. |
| Id | Classification identifier | integer | None. |
| Name | Classification name | string | None. |
| ParentCategories | List of parent categories in the product tree in the order they appear in Cova Hub | Collection of CategoryItem | None. |
SupplierSkuResource
Represents a supplier SKU associated with a product.
| Name | Description | Type | Additional information |
|---|---|---|---|
| SKU | Supplier SKU. | string | None. |
| SupplierId | ID of the supplier associated with the SKU. Nullable | integer | None. |
| Supplier | Name of the supplier associated with the SKU. | string | None. |
| Description | Description associated with the supplier SKU. | string | None. |
ManufacturerSkuResource
Represents a manufacturer SKU associated with a product.
| Name | Description | Type | Additional information |
|---|---|---|---|
| SKU | Manufacturer SKU. | string | None. |
| Description | Description associated with the manufacturer SKU. | string | None. |
UpcResource
Represents a UPC associated with a product.
| Name | Description | Type | Additional information |
|---|---|---|---|
| UPC | string | None. | |
| Description | Description associated with the UPC. | string | None. |
SpecificationResource
Represents a specification associated with a product.
| Name | Description | Type | Additional information |
|---|---|---|---|
| FieldGroupId | The ID of the group the specification belongs to. | globally unique identifier | None. |
| FieldGroup | The group the specification belongs to. Example: Details | string | None. |
| FieldId | The ID of the specification. | integer | None. |
| FieldName | The name of the specification. Example: Retail Marijuana Product Type | string | None. |
| StringId | The string id of the specification. | string | None. |
| DisplayName | The display name of the specification. Example: Retail Marijuana Product Type. Use this value to find particular specification fields | string | None. |
| Value | The value that is set for the field. Comma delimited for 'MultiSelect' type fields | string | None. |
| Type | The type of specification in relation to Cova Hub controls. Valid values: 'TextSingleLine','SingleSelect','MultiSelect','Float','TextMultipleLine','YesNo' | string | None. |
| Unit | The unit the value is measured in if applicable. Example: g, oz | string | None. |
AssetResource
Product asset resource.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | Unique identifier of the asset. | globally unique identifier | None. |
| Name | Asset name. | string | None. |
| Uri | Uri to the asset. | string | None. |
| Type | Asset type. | string | None. |
| IsHidden | Indicates if the asset is hidden. | boolean | None. |
AvailabilityResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationId | Location (store) identifier where this product exists | integer | None. |
| RoomId | Room identifier within a location. For example "Receiving Room" or "Sales Floor" | integer | None. |
| PackageId | Identifier typically controlled by a governing body (METRC, OCS, etc) | string | None. |
| BatchId | Additional package tracking information | string | None. |
| UnitId | Internal identifier for the unit of measure. i.e. 0 is 'Single Unit'. 103 is gram, 110 is milligram | integer | None. |
| InStockQuantity | Quantity of this product in stock, at this location, in this room. | decimal number | None. |
| OnOrderQuantity | Quantity 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 number | None. |
| TransferInQuantity | Quantity of this product on an incoming transfer | decimal number | None. |
| TransferOutQuantity | Quantity of this product on an outgoing transfer | decimal number | None. |
| OnHoldQuantity | The amount currently on hold in display units. | decimal number | None. |
| TotalCostInStock | The retailer's total cost of these products | decimal number | None. |
| UnitCost | The retailer's per-unit cost for these products | decimal number | None. |
| ReceivedDate | UTC datetime of when these products were received into inventory | date | None. |
| UpdatedDateUtc | UTC datetime of when this record was last updated (i.e. quantity changed, etc). | date | None. |
| IsSellingRoom | Indicates if the room this inventory is in the default selling room. | boolean | None. |
| FirstReceivedDateUtc | The 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 received | date | None. |
PriceResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationId | Location (store) identifier where this price is valid | integer | None. |
| FromEntityId | The entity where the price is inherited from | integer | None. |
| ProductId | Used throughout Cova as the main identifier for a product | globally unique identifier | None. |
| TierId | Tier 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 price | integer | None. |
| TierName | Name of the tier, if applicable | string | None. |
| TierQuantity | Minimum quantity to qualify for the tier price Nullable if not a tiered price | decimal number | None. |
| AtTierPriceAppliesUpTo | For 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 pricing | decimal number | None. |
| GroupId | Identifier of a pricing group, if applicable | integer | None. |
| GroupName | Name of the pricing group. For example: Veterans, Employees Nullable if not a group price | string | None. |
| ShelfId | Identifier 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. | integer | None. |
| ShelfName | Name of the pricing shelf, if applicable Nullable if not a shelf price | string | None. |
| Price | Regular price for this product | decimal number | None. |
| AtTierPrice | Price 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 price | decimal number | None. |
| SalePrices | Collection of SalePriceResource | None. | |
| UpdatedDateUtc | The UTC datetime this pricing record was last modified | date | None. |
CompanyLevelRegularPriceResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| Price | The regular price set at the company level for this product | decimal number | None. |
| SalePrices | Collection of sale prices set on the regular price at the company level | Collection of CompanyLevelRegularSalePriceResource | None. |
CannabinoidResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| CannabinoidType | The cannabinoid. Example: THC, CBD | string | None. |
| MeasurementType | How the cannabinoid is measured. Example: percent, mg | string | None. |
| MinValue | The minimum value entered for the cannabinoid. | decimal number | None. |
| MaxValue | The maximum value entered for the cannabinoid. | decimal number | None. |
RetailIdRangeResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| RangeStart | Starting id of the range of retail ids. | integer | None. |
| RangeEnd | Ending id of the range of retail ids. | integer | None. |
| CreatedDateUtc | The date the retail id range was created. | date | None. |
CategoryItem
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer | None. | |
| Name | string | None. |
SalePriceResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| SalePrice | The sale price for this product | decimal number | None. |
| AtTierSalePrice | Sale Price for this product at the lower bound (TierQuantity). Always use this price when calculating totals for tiered products. Nullable if not a tiered price | decimal number | None. |
| StartDateUtc | UTC datetime for when the sale begins Nullable | date | None. |
| StopDateUtc | UTC datetime for when the sale ends Nullable | date | None. |
CompanyLevelRegularSalePriceResource
| Name | Description | Type | Additional information |
|---|---|---|---|
| SalePrice | The company level regular sale price for this product | decimal number | None. |
| StartDateUtc | UTC datetime for when the sale begins Nullable | date | None. |
| StopDateUtc | UTC datetime for when the sale ends Nullable | date | None. |