POST v1/companies/{companyId}/DetailedProductData/ByProductIdList

This call is intended to target data for a list of specific products

Information:

Additional Documentation

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

Sample:

{
  "LocationId": 1,
  "ProductIds": [
    "f1a80e5c-0082-4ed6-baea-048fa25d8537",
    "6018d0f8-1152-43e8-a9ce-f7c7c0ac4f84"
  ],
  "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

Resource Description

DetailedProductDataResource

Name	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": "350269d5-3ed2-4c9b-a493-bff175da1f17",
      "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": "1eb0038b-42c0-4d06-80a0-7b53cae198e2",
      "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": "ce6d25bf-7385-4bf7-9c3b-7766ea6acbd5",
          "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": "ce6d25bf-7385-4bf7-9c3b-7766ea6acbd5",
          "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": "62320d3a-b0c0-4e24-9e5f-ce7ace52a45b",
          "Name": "sample string 2",
          "Uri": "sample string 3",
          "Type": "sample string 4",
          "IsHidden": true
        },
        {
          "Id": "62320d3a-b0c0-4e24-9e5f-ce7ace52a45b",
          "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,
          "OnOrderQuantity": 7.0,
          "TransferInQuantity": 8.0,
          "TransferOutQuantity": 9.0,
          "TotalCostInStock": 10.0,
          "UnitCost": 11.0,
          "ReceivedDate": "2025-12-11T16:29:45.3923017+00:00",
          "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
          "IsSellingRoom": true,
          "FirstReceivedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
        },
        {
          "LocationId": 1,
          "RoomId": 2,
          "PackageId": "sample string 3",
          "BatchId": "sample string 4",
          "UnitId": 5,
          "InStockQuantity": 6.0,
          "OnOrderQuantity": 7.0,
          "TransferInQuantity": 8.0,
          "TransferOutQuantity": 9.0,
          "TotalCostInStock": 10.0,
          "UnitCost": 11.0,
          "ReceivedDate": "2025-12-11T16:29:45.3923017+00:00",
          "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
          "IsSellingRoom": true,
          "FirstReceivedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
        }
      ],
      "Prices": [
        {
          "LocationId": 1,
          "ProductId": "05e6bdd0-d223-4e78-8376-e1f4ce023d44",
          "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": "2025-12-11T16:29:45.3923017+00:00",
              "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
            },
            {
              "SalePrice": 1.0,
              "AtTierSalePrice": 1.0,
              "StartDateUtc": "2025-12-11T16:29:45.3923017+00:00",
              "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
            }
          ],
          "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
        },
        {
          "LocationId": 1,
          "ProductId": "05e6bdd0-d223-4e78-8376-e1f4ce023d44",
          "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": "2025-12-11T16:29:45.3923017+00:00",
              "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
            },
            {
              "SalePrice": 1.0,
              "AtTierSalePrice": 1.0,
              "StartDateUtc": "2025-12-11T16:29:45.3923017+00:00",
              "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
            }
          ],
          "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
        }
      ],
      "CreatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
      "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
      "ApplicableTaxRates": [
        "16ac7d9e-2eeb-4239-93fa-3167b7ff3c64",
        "9f57941d-5a22-4888-a985-698b7fbafb23"
      ],
      "ClassificationTreeId": 20,
      "Manufacturer": "sample string 21",
      "MSRP": 1.0,
      "MSRPCurrencyCode": "sample string 22",
      "CompanyLevelRegularPrice": {
        "Price": 1.0,
        "SalePrices": [
          {
            "SalePrice": 1.0,
            "StartDateUtc": "2025-12-11T16:29:45.3923017+00:00",
            "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
          },
          {
            "SalePrice": 1.0,
            "StartDateUtc": "2025-12-11T16:29:45.3923017+00:00",
            "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
          }
        ]
      }
    },
    {
      "ProductId": "350269d5-3ed2-4c9b-a493-bff175da1f17",
      "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": "1eb0038b-42c0-4d06-80a0-7b53cae198e2",
      "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": "ce6d25bf-7385-4bf7-9c3b-7766ea6acbd5",
          "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": "ce6d25bf-7385-4bf7-9c3b-7766ea6acbd5",
          "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": "62320d3a-b0c0-4e24-9e5f-ce7ace52a45b",
          "Name": "sample string 2",
          "Uri": "sample string 3",
          "Type": "sample string 4",
          "IsHidden": true
        },
        {
          "Id": "62320d3a-b0c0-4e24-9e5f-ce7ace52a45b",
          "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,
          "OnOrderQuantity": 7.0,
          "TransferInQuantity": 8.0,
          "TransferOutQuantity": 9.0,
          "TotalCostInStock": 10.0,
          "UnitCost": 11.0,
          "ReceivedDate": "2025-12-11T16:29:45.3923017+00:00",
          "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
          "IsSellingRoom": true,
          "FirstReceivedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
        },
        {
          "LocationId": 1,
          "RoomId": 2,
          "PackageId": "sample string 3",
          "BatchId": "sample string 4",
          "UnitId": 5,
          "InStockQuantity": 6.0,
          "OnOrderQuantity": 7.0,
          "TransferInQuantity": 8.0,
          "TransferOutQuantity": 9.0,
          "TotalCostInStock": 10.0,
          "UnitCost": 11.0,
          "ReceivedDate": "2025-12-11T16:29:45.3923017+00:00",
          "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
          "IsSellingRoom": true,
          "FirstReceivedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
        }
      ],
      "Prices": [
        {
          "LocationId": 1,
          "ProductId": "05e6bdd0-d223-4e78-8376-e1f4ce023d44",
          "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": "2025-12-11T16:29:45.3923017+00:00",
              "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
            },
            {
              "SalePrice": 1.0,
              "AtTierSalePrice": 1.0,
              "StartDateUtc": "2025-12-11T16:29:45.3923017+00:00",
              "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
            }
          ],
          "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
        },
        {
          "LocationId": 1,
          "ProductId": "05e6bdd0-d223-4e78-8376-e1f4ce023d44",
          "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": "2025-12-11T16:29:45.3923017+00:00",
              "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
            },
            {
              "SalePrice": 1.0,
              "AtTierSalePrice": 1.0,
              "StartDateUtc": "2025-12-11T16:29:45.3923017+00:00",
              "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
            }
          ],
          "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
        }
      ],
      "CreatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
      "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
      "ApplicableTaxRates": [
        "16ac7d9e-2eeb-4239-93fa-3167b7ff3c64",
        "9f57941d-5a22-4888-a985-698b7fbafb23"
      ],
      "ClassificationTreeId": 20,
      "Manufacturer": "sample string 21",
      "MSRP": 1.0,
      "MSRPCurrencyCode": "sample string 22",
      "CompanyLevelRegularPrice": {
        "Price": 1.0,
        "SalePrices": [
          {
            "SalePrice": 1.0,
            "StartDateUtc": "2025-12-11T16:29:45.3923017+00:00",
            "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
          },
          {
            "SalePrice": 1.0,
            "StartDateUtc": "2025-12-11T16:29:45.3923017+00:00",
            "StopDateUtc": "2025-12-11T16:29:45.3923017+00:00"
          }
        ]
      }
    }
  ],
  "Packages": [
    {
      "PackageId": "sample string 1",
      "BatchId": "sample string 2",
      "ExpiryDate": "2025-12-11T16:29:45.3923017+00:00",
      "Strain": "sample string 3",
      "SupplierLicense": "sample string 4",
      "TestDate": "2025-12-11T16:29:45.3923017+00:00",
      "HarvestDate": "2025-12-11T16:29:45.3923017+00:00",
      "TestingFacilityName": "sample string 5",
      "TestBatchNumber": "sample string 6",
      "SupplierName": "sample string 7",
      "SupplierId": 1,
      "TerpeneProfile": "sample string 8",
      "ReceivingId": "cdfc4bbb-1fae-4377-af89-e696a1fe5653",
      "ReceivingDate": "2025-12-11T16:29:45.3923017+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": "2025-12-11T16:29:45.3923017+00:00",
      "ProductionDate": "2025-12-11T16:29:45.3923017+00:00",
      "CreatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
      "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
    },
    {
      "PackageId": "sample string 1",
      "BatchId": "sample string 2",
      "ExpiryDate": "2025-12-11T16:29:45.3923017+00:00",
      "Strain": "sample string 3",
      "SupplierLicense": "sample string 4",
      "TestDate": "2025-12-11T16:29:45.3923017+00:00",
      "HarvestDate": "2025-12-11T16:29:45.3923017+00:00",
      "TestingFacilityName": "sample string 5",
      "TestBatchNumber": "sample string 6",
      "SupplierName": "sample string 7",
      "SupplierId": 1,
      "TerpeneProfile": "sample string 8",
      "ReceivingId": "cdfc4bbb-1fae-4377-af89-e696a1fe5653",
      "ReceivingDate": "2025-12-11T16:29:45.3923017+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": "2025-12-11T16:29:45.3923017+00:00",
      "ProductionDate": "2025-12-11T16:29:45.3923017+00:00",
      "CreatedDateUtc": "2025-12-11T16:29:45.3923017+00:00",
      "UpdatedDateUtc": "2025-12-11T16:29:45.3923017+00:00"
    }
  ],
  "TaxRates": [
    {
      "Id": "3559212b-9b9c-4587-bdf1-845325156405",
      "Name": "sample string 2",
      "Type": "sample string 3",
      "Rate": 4.0,
      "Layer": 5,
      "CalculatedOn": "sample string 6",
      "Locations": [
        1,
        2
      ]
    },
    {
      "Id": "3559212b-9b9c-4587-bdf1-845325156405",
      "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"
        }
      ]
    }
  ]
}