POST 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
Information:
Additional Documentation
See Cova Data Platform API guide
Base URL:
https://api.covasoft.net/dataplatform
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,
"SellingRoomOnly": true,
"Skip": 0,
"Top": 100
}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyId | integer |
Required |
Body Parameters
Properties to define which items in the model 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. |
| IncludeClassifications |
Indicates whether to include the classification collection |
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 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. |
| IncludeTaxes |
Indicates whether to include applicable product tax rate data. |
boolean |
None. |
| IncludeAllLifecycles |
Indicates whether to include all lifecycles, or only Active products |
boolean |
None. |
| Skip |
Number of records to skip. |
integer |
None. |
| Top |
Number of records to take. |
integer |
Range: inclusive between 1 and 500 |
Request Formats
application/json, text/json
Sample:
{
"LocationId": 1,
"IncludeProductSkusAndUpcs": true,
"IncludeProductSpecifications": true,
"IncludeClassifications": true,
"IncludeProductAssets": true,
"IncludeAvailability": true,
"IncludePackageDetails": true,
"InStockOnly": true,
"SellingRoomOnly": true,
"IncludePricing": true,
"IncludeTaxes": true,
"IncludeAllLifecycles": true,
"Skip": 12,
"Top": 13
}
Response Information
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
Sample:
{
"Products": [
{
"ProductId": "c09ca65f-e4b6-4c66-9546-370f3665915f",
"MasterProductId": 2,
"MasterProductName": 3,
"VariationId": 1,
"Slug": "sample string 4",
"CatalogSku": "sample string 5",
"IsArchived": true,
"MeasurementType": "sample string 7",
"IsBatchTracked": true,
"IsNonStock": true,
"LifeCycle": "sample string 10",
"ClassificationId": 11,
"ClassificationName": "sample string 12",
"ClassificationPath": "sample string 13",
"Name": "sample string 14",
"ShortDescription": "sample string 15",
"LongDescription": "sample string 16",
"HeroShotAssetId": "6ace0c83-3ade-4d45-abac-23ab8b1f83ef",
"HeroShotUri": "sample string 17",
"SupplierSkus": [
{
"SKU": "sample string 1",
"SupplierId": 1,
"Supplier": "sample string 2",
"Description": "sample string 3"
},
{
"SKU": "sample string 1",
"SupplierId": 1,
"Supplier": "sample string 2",
"Description": "sample string 3"
}
],
"ManufacturerSkus": [
{
"SKU": "sample string 1",
"Description": "sample string 2"
},
{
"SKU": "sample string 1",
"Description": "sample string 2"
}
],
"Upcs": [
{
"UPC": "sample string 1",
"Description": "sample string 2"
},
{
"UPC": "sample string 1",
"Description": "sample string 2"
}
],
"ProductSpecifications": [
{
"FieldGroupId": "8984ff25-231b-452d-8940-be0a31683bb5",
"FieldGroup": "sample string 2",
"FieldId": 3,
"FieldName": "sample string 4",
"StringId": "sample string 5",
"DisplayName": "sample string 6",
"Value": "sample string 7",
"Type": "sample string 8",
"Unit": "sample string 9"
},
{
"FieldGroupId": "8984ff25-231b-452d-8940-be0a31683bb5",
"FieldGroup": "sample string 2",
"FieldId": 3,
"FieldName": "sample string 4",
"StringId": "sample string 5",
"DisplayName": "sample string 6",
"Value": "sample string 7",
"Type": "sample string 8",
"Unit": "sample string 9"
}
],
"Assets": [
{
"Id": "5c6c2d9e-a0dc-4da1-b903-378a64322d40",
"Name": "sample string 2",
"Uri": "sample string 3",
"Type": "sample string 4",
"IsHidden": true
},
{
"Id": "5c6c2d9e-a0dc-4da1-b903-378a64322d40",
"Name": "sample string 2",
"Uri": "sample string 3",
"Type": "sample string 4",
"IsHidden": true
}
],
"Availability": [
{
"LocationId": 1,
"RoomId": 2,
"PackageId": "sample string 3",
"BatchId": "sample string 4",
"UnitId": 5,
"InStockQuantity": 6.0,
"TotalCostInStock": 7.0,
"UnitCost": 8.0,
"ReceivedDate": "2024-11-07T09:00:02.0591326+00:00",
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
},
{
"LocationId": 1,
"RoomId": 2,
"PackageId": "sample string 3",
"BatchId": "sample string 4",
"UnitId": 5,
"InStockQuantity": 6.0,
"TotalCostInStock": 7.0,
"UnitCost": 8.0,
"ReceivedDate": "2024-11-07T09:00:02.0591326+00:00",
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
}
],
"Prices": [
{
"LocationId": 1,
"ProductId": "4223dae5-0dd6-4538-a5bb-731f770c4997",
"TierId": 1,
"TierName": "sample string 3",
"TierQuantity": 1.0,
"GroupId": 1,
"GroupName": "sample string 4",
"ShelfId": 1,
"ShelfName": "sample string 5",
"Price": 6.0,
"AtTierPrice": 1.0,
"SalePrices": [
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"StopDateUtc": "2024-11-07T09:00:02.0591326+00:00"
},
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"StopDateUtc": "2024-11-07T09:00:02.0591326+00:00"
}
],
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
},
{
"LocationId": 1,
"ProductId": "4223dae5-0dd6-4538-a5bb-731f770c4997",
"TierId": 1,
"TierName": "sample string 3",
"TierQuantity": 1.0,
"GroupId": 1,
"GroupName": "sample string 4",
"ShelfId": 1,
"ShelfName": "sample string 5",
"Price": 6.0,
"AtTierPrice": 1.0,
"SalePrices": [
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"StopDateUtc": "2024-11-07T09:00:02.0591326+00:00"
},
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"StopDateUtc": "2024-11-07T09:00:02.0591326+00:00"
}
],
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
}
],
"CreatedDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"ApplicableTaxRates": [
"2dfe1620-064b-4bcd-99ca-9b233972009d",
"09131b56-e9ea-462a-aaef-32ccedad8333"
],
"ClassificationTreeId": 20,
"Manufacturer": "sample string 21",
"MSRP": 1.0,
"MSRPCurrencyCode": "sample string 22"
},
{
"ProductId": "c09ca65f-e4b6-4c66-9546-370f3665915f",
"MasterProductId": 2,
"MasterProductName": 3,
"VariationId": 1,
"Slug": "sample string 4",
"CatalogSku": "sample string 5",
"IsArchived": true,
"MeasurementType": "sample string 7",
"IsBatchTracked": true,
"IsNonStock": true,
"LifeCycle": "sample string 10",
"ClassificationId": 11,
"ClassificationName": "sample string 12",
"ClassificationPath": "sample string 13",
"Name": "sample string 14",
"ShortDescription": "sample string 15",
"LongDescription": "sample string 16",
"HeroShotAssetId": "6ace0c83-3ade-4d45-abac-23ab8b1f83ef",
"HeroShotUri": "sample string 17",
"SupplierSkus": [
{
"SKU": "sample string 1",
"SupplierId": 1,
"Supplier": "sample string 2",
"Description": "sample string 3"
},
{
"SKU": "sample string 1",
"SupplierId": 1,
"Supplier": "sample string 2",
"Description": "sample string 3"
}
],
"ManufacturerSkus": [
{
"SKU": "sample string 1",
"Description": "sample string 2"
},
{
"SKU": "sample string 1",
"Description": "sample string 2"
}
],
"Upcs": [
{
"UPC": "sample string 1",
"Description": "sample string 2"
},
{
"UPC": "sample string 1",
"Description": "sample string 2"
}
],
"ProductSpecifications": [
{
"FieldGroupId": "8984ff25-231b-452d-8940-be0a31683bb5",
"FieldGroup": "sample string 2",
"FieldId": 3,
"FieldName": "sample string 4",
"StringId": "sample string 5",
"DisplayName": "sample string 6",
"Value": "sample string 7",
"Type": "sample string 8",
"Unit": "sample string 9"
},
{
"FieldGroupId": "8984ff25-231b-452d-8940-be0a31683bb5",
"FieldGroup": "sample string 2",
"FieldId": 3,
"FieldName": "sample string 4",
"StringId": "sample string 5",
"DisplayName": "sample string 6",
"Value": "sample string 7",
"Type": "sample string 8",
"Unit": "sample string 9"
}
],
"Assets": [
{
"Id": "5c6c2d9e-a0dc-4da1-b903-378a64322d40",
"Name": "sample string 2",
"Uri": "sample string 3",
"Type": "sample string 4",
"IsHidden": true
},
{
"Id": "5c6c2d9e-a0dc-4da1-b903-378a64322d40",
"Name": "sample string 2",
"Uri": "sample string 3",
"Type": "sample string 4",
"IsHidden": true
}
],
"Availability": [
{
"LocationId": 1,
"RoomId": 2,
"PackageId": "sample string 3",
"BatchId": "sample string 4",
"UnitId": 5,
"InStockQuantity": 6.0,
"TotalCostInStock": 7.0,
"UnitCost": 8.0,
"ReceivedDate": "2024-11-07T09:00:02.0591326+00:00",
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
},
{
"LocationId": 1,
"RoomId": 2,
"PackageId": "sample string 3",
"BatchId": "sample string 4",
"UnitId": 5,
"InStockQuantity": 6.0,
"TotalCostInStock": 7.0,
"UnitCost": 8.0,
"ReceivedDate": "2024-11-07T09:00:02.0591326+00:00",
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
}
],
"Prices": [
{
"LocationId": 1,
"ProductId": "4223dae5-0dd6-4538-a5bb-731f770c4997",
"TierId": 1,
"TierName": "sample string 3",
"TierQuantity": 1.0,
"GroupId": 1,
"GroupName": "sample string 4",
"ShelfId": 1,
"ShelfName": "sample string 5",
"Price": 6.0,
"AtTierPrice": 1.0,
"SalePrices": [
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"StopDateUtc": "2024-11-07T09:00:02.0591326+00:00"
},
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"StopDateUtc": "2024-11-07T09:00:02.0591326+00:00"
}
],
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
},
{
"LocationId": 1,
"ProductId": "4223dae5-0dd6-4538-a5bb-731f770c4997",
"TierId": 1,
"TierName": "sample string 3",
"TierQuantity": 1.0,
"GroupId": 1,
"GroupName": "sample string 4",
"ShelfId": 1,
"ShelfName": "sample string 5",
"Price": 6.0,
"AtTierPrice": 1.0,
"SalePrices": [
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"StopDateUtc": "2024-11-07T09:00:02.0591326+00:00"
},
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"StopDateUtc": "2024-11-07T09:00:02.0591326+00:00"
}
],
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
}
],
"CreatedDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"ApplicableTaxRates": [
"2dfe1620-064b-4bcd-99ca-9b233972009d",
"09131b56-e9ea-462a-aaef-32ccedad8333"
],
"ClassificationTreeId": 20,
"Manufacturer": "sample string 21",
"MSRP": 1.0,
"MSRPCurrencyCode": "sample string 22"
}
],
"Packages": [
{
"PackageId": "sample string 1",
"BatchId": "sample string 2",
"ExpiryDate": "2024-11-07T09:00:02.0591326+00:00",
"Strain": "sample string 3",
"SupplierLicense": "sample string 4",
"TestDate": "2024-11-07T09:00:02.0591326+00:00",
"HarvestDate": "2024-11-07T09:00:02.0591326+00:00",
"TestingFacilityName": "sample string 5",
"TestBatchNumber": "sample string 6",
"SupplierName": "sample string 7",
"SupplierId": 1,
"TerpeneProfile": "sample string 8",
"ReceivingId": "ece4b3e2-5841-4bf0-a700-8479e4a96300",
"ReceivingDate": "2024-11-07T09:00:02.0591326+00:00",
"Cannabinoids": [
{
"CannabinoidType": "sample string 1",
"MeasurementType": "sample string 2",
"MinValue": 3.0,
"MaxValue": 4.0
},
{
"CannabinoidType": "sample string 1",
"MeasurementType": "sample string 2",
"MinValue": 3.0,
"MaxValue": 4.0
}
],
"PackagedDate": "2024-11-07T09:00:02.0591326+00:00",
"ProductionDate": "2024-11-07T09:00:02.0591326+00:00",
"CreatedDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
},
{
"PackageId": "sample string 1",
"BatchId": "sample string 2",
"ExpiryDate": "2024-11-07T09:00:02.0591326+00:00",
"Strain": "sample string 3",
"SupplierLicense": "sample string 4",
"TestDate": "2024-11-07T09:00:02.0591326+00:00",
"HarvestDate": "2024-11-07T09:00:02.0591326+00:00",
"TestingFacilityName": "sample string 5",
"TestBatchNumber": "sample string 6",
"SupplierName": "sample string 7",
"SupplierId": 1,
"TerpeneProfile": "sample string 8",
"ReceivingId": "ece4b3e2-5841-4bf0-a700-8479e4a96300",
"ReceivingDate": "2024-11-07T09:00:02.0591326+00:00",
"Cannabinoids": [
{
"CannabinoidType": "sample string 1",
"MeasurementType": "sample string 2",
"MinValue": 3.0,
"MaxValue": 4.0
},
{
"CannabinoidType": "sample string 1",
"MeasurementType": "sample string 2",
"MinValue": 3.0,
"MaxValue": 4.0
}
],
"PackagedDate": "2024-11-07T09:00:02.0591326+00:00",
"ProductionDate": "2024-11-07T09:00:02.0591326+00:00",
"CreatedDateUtc": "2024-11-07T09:00:02.0591326+00:00",
"UpdatedDateUtc": "2024-11-07T09:00:02.0591326+00:00"
}
],
"TaxRates": [
{
"Id": "4445d28f-1f2a-4b3f-9b7e-879f8f7ba513",
"Name": "sample string 2",
"Type": "sample string 3",
"Rate": 4.0,
"Layer": 5,
"CalculatedOn": "sample string 6",
"Locations": [
1,
2
]
},
{
"Id": "4445d28f-1f2a-4b3f-9b7e-879f8f7ba513",
"Name": "sample string 2",
"Type": "sample string 3",
"Rate": 4.0,
"Layer": 5,
"CalculatedOn": "sample string 6",
"Locations": [
1,
2
]
}
],
"Classifications": [
{
"TreeId": 1,
"Id": 2,
"Name": "sample string 3",
"ParentCategories": [
{
"Id": 1,
"Name": "sample string 2"
},
{
"Id": 1,
"Name": "sample string 2"
}
]
},
{
"TreeId": 1,
"Id": 2,
"Name": "sample string 3",
"ParentCategories": [
{
"Id": 1,
"Name": "sample string 2"
},
{
"Id": 1,
"Name": "sample string 2"
}
]
}
]
}