POST v1/companies/{companyId}/DetailedProductData/ByProductIdList
This call is intended to target data for a list of specific products
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/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,
"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 items in the model to return.
DetailedProductDataByProductIdListRequestResourceName | 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 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 applicable product tax rate data. |
boolean |
None. |
IncludeAllLifecycles |
Indicates whether to include all lifecycles, or only Active products |
boolean |
None. |
ProductIds |
List of Product Id's to get data for. Maximum of 500 |
Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
{ "LocationId": 1, "IncludeProductSkusAndUpcs": true, "IncludeProductSpecifications": true, "IncludeClassifications": true, "IncludeProductAssets": true, "IncludeAvailability": true, "IncludePackageDetails": true, "InStockOnly": true, "SellingRoomOnly": true, "IncludePricing": true, "IncludeTaxes": true, "IncludeAllLifecycles": true, "ProductIds": [ "032e5645-3ff5-4470-a054-0dc4eb890ebf", "97388afb-339b-4fe9-b69a-12a1cf3590ed" ] }
Response Information
Resource Description
DetailedProductDataResourceName | 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": "6dae4978-4eff-4f68-88d5-816aec2139dc", "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": "ce276e12-4c31-4180-8e10-df488ca461cc", "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": "ce839c7f-b8c2-4867-95f2-e80da2882a6d", "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": "ce839c7f-b8c2-4867-95f2-e80da2882a6d", "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": "50da3fd8-a816-44c2-967f-44c6f76810af", "Name": "sample string 2", "Uri": "sample string 3", "Type": "sample string 4", "IsHidden": true }, { "Id": "50da3fd8-a816-44c2-967f-44c6f76810af", "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-25T11:25:50.3999694+00:00", "UpdatedDateUtc": "2024-11-25T11:25:50.3999694+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-25T11:25:50.3999694+00:00", "UpdatedDateUtc": "2024-11-25T11:25:50.3999694+00:00" } ], "Prices": [ { "LocationId": 1, "ProductId": "66a0c17f-322b-4e71-923b-13311af84f31", "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-25T11:25:50.4155956+00:00", "StopDateUtc": "2024-11-25T11:25:50.4155956+00:00" }, { "SalePrice": 1.0, "AtTierSalePrice": 1.0, "StartDateUtc": "2024-11-25T11:25:50.4155956+00:00", "StopDateUtc": "2024-11-25T11:25:50.4155956+00:00" } ], "UpdatedDateUtc": "2024-11-25T11:25:50.4155956+00:00" }, { "LocationId": 1, "ProductId": "66a0c17f-322b-4e71-923b-13311af84f31", "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-25T11:25:50.4155956+00:00", "StopDateUtc": "2024-11-25T11:25:50.4155956+00:00" }, { "SalePrice": 1.0, "AtTierSalePrice": 1.0, "StartDateUtc": "2024-11-25T11:25:50.4155956+00:00", "StopDateUtc": "2024-11-25T11:25:50.4155956+00:00" } ], "UpdatedDateUtc": "2024-11-25T11:25:50.4155956+00:00" } ], "CreatedDateUtc": "2024-11-25T11:25:50.4155956+00:00", "UpdatedDateUtc": "2024-11-25T11:25:50.4155956+00:00", "ApplicableTaxRates": [ "c4d735d2-ebd1-4341-b1d5-61d8b0e106d5", "fd54cd75-ff5b-441c-a4e5-b583074fde3d" ], "ClassificationTreeId": 20, "Manufacturer": "sample string 21", "MSRP": 1.0, "MSRPCurrencyCode": "sample string 22" }, { "ProductId": "6dae4978-4eff-4f68-88d5-816aec2139dc", "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": "ce276e12-4c31-4180-8e10-df488ca461cc", "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": "ce839c7f-b8c2-4867-95f2-e80da2882a6d", "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": "ce839c7f-b8c2-4867-95f2-e80da2882a6d", "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": "50da3fd8-a816-44c2-967f-44c6f76810af", "Name": "sample string 2", "Uri": "sample string 3", "Type": "sample string 4", "IsHidden": true }, { "Id": "50da3fd8-a816-44c2-967f-44c6f76810af", "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-25T11:25:50.3999694+00:00", "UpdatedDateUtc": "2024-11-25T11:25:50.3999694+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-25T11:25:50.3999694+00:00", "UpdatedDateUtc": "2024-11-25T11:25:50.3999694+00:00" } ], "Prices": [ { "LocationId": 1, "ProductId": "66a0c17f-322b-4e71-923b-13311af84f31", "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-25T11:25:50.4155956+00:00", "StopDateUtc": "2024-11-25T11:25:50.4155956+00:00" }, { "SalePrice": 1.0, "AtTierSalePrice": 1.0, "StartDateUtc": "2024-11-25T11:25:50.4155956+00:00", "StopDateUtc": "2024-11-25T11:25:50.4155956+00:00" } ], "UpdatedDateUtc": "2024-11-25T11:25:50.4155956+00:00" }, { "LocationId": 1, "ProductId": "66a0c17f-322b-4e71-923b-13311af84f31", "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-25T11:25:50.4155956+00:00", "StopDateUtc": "2024-11-25T11:25:50.4155956+00:00" }, { "SalePrice": 1.0, "AtTierSalePrice": 1.0, "StartDateUtc": "2024-11-25T11:25:50.4155956+00:00", "StopDateUtc": "2024-11-25T11:25:50.4155956+00:00" } ], "UpdatedDateUtc": "2024-11-25T11:25:50.4155956+00:00" } ], "CreatedDateUtc": "2024-11-25T11:25:50.4155956+00:00", "UpdatedDateUtc": "2024-11-25T11:25:50.4155956+00:00", "ApplicableTaxRates": [ "c4d735d2-ebd1-4341-b1d5-61d8b0e106d5", "fd54cd75-ff5b-441c-a4e5-b583074fde3d" ], "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-25T11:25:50.4155956+00:00", "Strain": "sample string 3", "SupplierLicense": "sample string 4", "TestDate": "2024-11-25T11:25:50.4155956+00:00", "HarvestDate": "2024-11-25T11:25:50.4155956+00:00", "TestingFacilityName": "sample string 5", "TestBatchNumber": "sample string 6", "SupplierName": "sample string 7", "SupplierId": 1, "TerpeneProfile": "sample string 8", "ReceivingId": "e2db6fd0-b79d-4402-9fa7-c86174526ea2", "ReceivingDate": "2024-11-25T11:25:50.4155956+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-25T11:25:50.4155956+00:00", "ProductionDate": "2024-11-25T11:25:50.4155956+00:00", "CreatedDateUtc": "2024-11-25T11:25:50.4155956+00:00", "UpdatedDateUtc": "2024-11-25T11:25:50.4155956+00:00" }, { "PackageId": "sample string 1", "BatchId": "sample string 2", "ExpiryDate": "2024-11-25T11:25:50.4155956+00:00", "Strain": "sample string 3", "SupplierLicense": "sample string 4", "TestDate": "2024-11-25T11:25:50.4155956+00:00", "HarvestDate": "2024-11-25T11:25:50.4155956+00:00", "TestingFacilityName": "sample string 5", "TestBatchNumber": "sample string 6", "SupplierName": "sample string 7", "SupplierId": 1, "TerpeneProfile": "sample string 8", "ReceivingId": "e2db6fd0-b79d-4402-9fa7-c86174526ea2", "ReceivingDate": "2024-11-25T11:25:50.4155956+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-25T11:25:50.4155956+00:00", "ProductionDate": "2024-11-25T11:25:50.4155956+00:00", "CreatedDateUtc": "2024-11-25T11:25:50.4155956+00:00", "UpdatedDateUtc": "2024-11-25T11:25:50.4155956+00:00" } ], "TaxRates": [ { "Id": "2dda712e-5225-4f72-9cd4-2592f61c5759", "Name": "sample string 2", "Type": "sample string 3", "Rate": 4.0, "Layer": 5, "CalculatedOn": "sample string 6", "Locations": [ 1, 2 ] }, { "Id": "2dda712e-5225-4f72-9cd4-2592f61c5759", "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" } ] } ] }