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.
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. |
| 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
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,
"ProductIds": [
"1550682e-0fb4-4e6b-9639-47cb4a72e9ed",
"ec8ac4ab-04ef-4bf4-83d5-0d512f688e98"
]
}
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": "5ec3bb46-3b4b-4325-9017-2467b8855f4c",
"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": "647df5d2-cba9-46ec-bf8a-b9001889e903",
"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": "4faace96-2497-40b5-b590-10abd6fd84e5",
"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": "4faace96-2497-40b5-b590-10abd6fd84e5",
"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": "fa106c03-9bd7-4434-a214-2834a87ec97b",
"Name": "sample string 2",
"Uri": "sample string 3",
"Type": "sample string 4",
"IsHidden": true
},
{
"Id": "fa106c03-9bd7-4434-a214-2834a87ec97b",
"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-07T08:45:21.3190115+00:00",
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+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-07T08:45:21.3190115+00:00",
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00"
}
],
"Prices": [
{
"LocationId": 1,
"ProductId": "e92dbeff-e4c9-4a75-8c0b-1abcc48f7cb5",
"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-07T08:45:21.3190115+00:00",
"StopDateUtc": "2024-11-07T08:45:21.3190115+00:00"
},
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"StopDateUtc": "2024-11-07T08:45:21.3190115+00:00"
}
],
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00"
},
{
"LocationId": 1,
"ProductId": "e92dbeff-e4c9-4a75-8c0b-1abcc48f7cb5",
"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-07T08:45:21.3190115+00:00",
"StopDateUtc": "2024-11-07T08:45:21.3190115+00:00"
},
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"StopDateUtc": "2024-11-07T08:45:21.3190115+00:00"
}
],
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00"
}
],
"CreatedDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"ApplicableTaxRates": [
"721de373-0195-4081-b9b7-03921f0c3f0b",
"ddd860fe-0aae-479a-b1cf-c7b1fb08ef69"
],
"ClassificationTreeId": 20,
"Manufacturer": "sample string 21",
"MSRP": 1.0,
"MSRPCurrencyCode": "sample string 22"
},
{
"ProductId": "5ec3bb46-3b4b-4325-9017-2467b8855f4c",
"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": "647df5d2-cba9-46ec-bf8a-b9001889e903",
"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": "4faace96-2497-40b5-b590-10abd6fd84e5",
"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": "4faace96-2497-40b5-b590-10abd6fd84e5",
"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": "fa106c03-9bd7-4434-a214-2834a87ec97b",
"Name": "sample string 2",
"Uri": "sample string 3",
"Type": "sample string 4",
"IsHidden": true
},
{
"Id": "fa106c03-9bd7-4434-a214-2834a87ec97b",
"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-07T08:45:21.3190115+00:00",
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+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-07T08:45:21.3190115+00:00",
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00"
}
],
"Prices": [
{
"LocationId": 1,
"ProductId": "e92dbeff-e4c9-4a75-8c0b-1abcc48f7cb5",
"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-07T08:45:21.3190115+00:00",
"StopDateUtc": "2024-11-07T08:45:21.3190115+00:00"
},
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"StopDateUtc": "2024-11-07T08:45:21.3190115+00:00"
}
],
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00"
},
{
"LocationId": 1,
"ProductId": "e92dbeff-e4c9-4a75-8c0b-1abcc48f7cb5",
"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-07T08:45:21.3190115+00:00",
"StopDateUtc": "2024-11-07T08:45:21.3190115+00:00"
},
{
"SalePrice": 1.0,
"AtTierSalePrice": 1.0,
"StartDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"StopDateUtc": "2024-11-07T08:45:21.3190115+00:00"
}
],
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00"
}
],
"CreatedDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"ApplicableTaxRates": [
"721de373-0195-4081-b9b7-03921f0c3f0b",
"ddd860fe-0aae-479a-b1cf-c7b1fb08ef69"
],
"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-07T08:45:21.3190115+00:00",
"Strain": "sample string 3",
"SupplierLicense": "sample string 4",
"TestDate": "2024-11-07T08:45:21.3190115+00:00",
"HarvestDate": "2024-11-07T08:45:21.3190115+00:00",
"TestingFacilityName": "sample string 5",
"TestBatchNumber": "sample string 6",
"SupplierName": "sample string 7",
"SupplierId": 1,
"TerpeneProfile": "sample string 8",
"ReceivingId": "0c2f1349-7f4f-4be8-8db6-049090bd9195",
"ReceivingDate": "2024-11-07T08:45:21.3190115+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-07T08:45:21.3190115+00:00",
"ProductionDate": "2024-11-07T08:45:21.3190115+00:00",
"CreatedDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00"
},
{
"PackageId": "sample string 1",
"BatchId": "sample string 2",
"ExpiryDate": "2024-11-07T08:45:21.3190115+00:00",
"Strain": "sample string 3",
"SupplierLicense": "sample string 4",
"TestDate": "2024-11-07T08:45:21.3190115+00:00",
"HarvestDate": "2024-11-07T08:45:21.3190115+00:00",
"TestingFacilityName": "sample string 5",
"TestBatchNumber": "sample string 6",
"SupplierName": "sample string 7",
"SupplierId": 1,
"TerpeneProfile": "sample string 8",
"ReceivingId": "0c2f1349-7f4f-4be8-8db6-049090bd9195",
"ReceivingDate": "2024-11-07T08:45:21.3190115+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-07T08:45:21.3190115+00:00",
"ProductionDate": "2024-11-07T08:45:21.3190115+00:00",
"CreatedDateUtc": "2024-11-07T08:45:21.3190115+00:00",
"UpdatedDateUtc": "2024-11-07T08:45:21.3190115+00:00"
}
],
"TaxRates": [
{
"Id": "9cbd3025-8161-46dd-a489-4ca7ae7052b6",
"Name": "sample string 2",
"Type": "sample string 3",
"Rate": 4.0,
"Layer": 5,
"CalculatedOn": "sample string 6",
"Locations": [
1,
2
]
},
{
"Id": "9cbd3025-8161-46dd-a489-4ca7ae7052b6",
"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"
}
]
}
]
}