| 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 |
integer |
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. |
| 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. |