--- title: "getAllCompanyProductsEnhancedV1" method: GET path: "/cruise/companyproduct/v1/getAllCompanyProductsEnhanced" tags: ["Company Product Enhanced Service"] --- # getAllCompanyProductsEnhancedV1 `GET /cruise/companyproduct/v1/getAllCompanyProductsEnhanced` ## Request - Base URL: `//webservices-test.net-chef.com` (relative, and the document’s source URL is not known) - URL: `//webservices-test.net-chef.com/cruise/companyproduct/v1/getAllCompanyProductsEnhanced` - Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid` Retrieve all company products' details. Retrieve one company product's details using `productNumber` and `inculdeDetails`. ## Query parameters - `activeFlag` boolean - `includeDetails` boolean - `productNumber` string - `includeNull` boolean ## Headers - `authenticationtoken` string, required - `password` string, required - `sitename` string, required - `userid` string, required - `X-B3-TraceId` string ## Response `200` Success - CompanyProductEnhancedDetailsGet[] - `companyProductEnhancedAllergenAttributeDetails` CompanyProductEnhancedAllergenAttributeDetailDto[] - `activeFlag` 'N' | 'Y': Product allergen active status. - `nutritionClass` string, required: Nutrition classification. - `value` string, required: Nutrition classification. - `companyProductEnhancedConceptDetails` CompanyProductEnhancedConceptDetailDto[] - `activeFlag` 'N' | 'Y': Product details active flag. - `code` string, required: UPC code for product. - `companyProductEnhancedDepartmentDetails` CompanyProductEnhancedDepartmentDetailDto[] - `activeFlag` 'N' | 'Y': Department details active flag. - `code` string, required: Department UPC code. - `companyProductEnhancedHeaderDetails` CompanyProductEnhancedHeaderDto: CompanyProductEnhancedHeaderDto description - `activeFlag` 'N' | 'Y': Product active flag. - `allergenAttributes` CompanyProductEnhancedAllergenAttributeDetailDto[] - `activeFlag` 'N' | 'Y': Product allergen active status. - `nutritionClass` string, required: Nutrition classification. - `value` string, required: Nutrition classification. - `alternateNameFive` string: Alternate name for the product. - `alternateNameFour` string: Alternate name for the product. - `alternateNameOne` string: Alternate name for the product. - `alternateNameThree` string: Alternate name for the product. - `alternateNameTwo` string: Alternate name for the product. - `alternateUnitOneConversion` number: The Alt Unit 1 "Conversion" value, from the Company Product 'Count Units' tab. - `alternateUnitOnePackageType` string: The "Alt Unit 1" package type, from the Company Product 'Count Units' tab. - `alternateUnitThreeConversion` number: The Alt Unit 3 "Conversion" value, from the Company Product 'Count Units' tab. - `alternateUnitThreePackageType` string: The "Alt Unit 3" package type, from the Company Product 'Count Units' tab. - `alternateUnitTwoConversion` number: The Alt Unit 2 "Conversion" value, from the Company Product 'Count Units' tab. - `alternateUnitTwoPackageType` string: The "Alt Unit 2" package type, from the Company Product 'Count Units' tab. - `alternateUpcs` CompanyProductEnhancedUpcDetailDto[] - `activeFlag` 'N' | 'Y': Flag to indicate (Y/N) whether the Alternate UPC record is Active. If populated, must be ‘Y’ or ‘N’. If left blank, will default to ‘Y’. - `code` string, required: The Alternate "UPC" code for the Company Product. - `bidSheet` string: The Name of the bid sheet. - `bonded` 'N' | 'Y': The "Bonded" status flag, from the Company Product 'Purchasing' tab. Indicates (Y/N) whether the product should appear as a taxable product on the Net-Chef Customs Report. If left blank, will default to ‘N’. - `categoryName` string, required: The Category associated with the Company Product. - `comment` string: Entries here will populate the "Remarks" field on the bid sheet submitted to the vendor. - `concepts` CompanyProductEnhancedConceptDetailDto[] - `activeFlag` 'N' | 'Y': Product details active flag. - `code` string, required: UPC code for product. - `containerVolumeUnitPackageType` string: The Containerization Volume "Unit", from the Company Product 'Optional' tab. - `containerVolumeUnitQuantity` number: Containerization Volume "Quantity", from the Company Product 'Optional' tab. This should equal the number of Volume units in 1 Inventory Unit. - `containerWeightUnitPackageType` string: Containerization Weight "Unit", from the Company Product 'Optional' tab. - `containerWeightUnitQuantity` number: Containerization Weight "Quantity", from the Company Product 'Optional' tab. This should equal the number of Weight units in 1 Inventory Unit. - `countryOfOrigin` string: Country of Origin, from the Company Product 'Additional Attributes' tab. - `customsStatus` string: Custom Status, from the Company Product 'Additional Attributes' tab. - `departments` CompanyProductEnhancedDepartmentDetailDto[] - `activeFlag` 'N' | 'Y': Department details active flag. - `code` string, required: Department UPC code. - `governmentMinimumStock` string: Gov't Min Stock, from the Company Product 'Additional Attributes' tab. - `gradPlato` number: Grad Plato, from the Company Product 'Additional Attributes' tab. - `haccpCompliance` string: HACCP Compliance (Restriction) for the Company Product. - `inventoryUnitPackageType` string, required: The Inventory Unit for the Company Product. - `issueUnitOneConversion` number, required: The Issue Unit 1 "Conversion" value for the Company Product. This should equal the number of 'Issue Unit 1' units in 1 Inventory Unit. - `issueUnitOnePackageType` string, required: The Issue Unit 1 "Unit" for the Company Product. - `issueUnitTwoConversion` number, required: The Issue Unit 2 "Conversion" value for the Company Product. This should equal the number of 'Issue Unit 2' units in 1 Inventory Unit. - `issueUnitTwoInverted` 'N' | 'Y': Flag to indicate (Y/N) whether the Issue Unit 2 conversion equation should be inverted. If 'Y', this should equal the number of Inventory Units in 1 'Issue Unit 2' unit. - `issueUnitTwoPackageType` string, required: The Issue Unit 2 "Unit" for the Company Product. - `labelType` '1' | '2' | '3' | '4': Indicates the Label Type for the Company Product, from Company Products 'Optional' tab. If populated, must be ‘1’ for System, ’2’ for 'Bar Tag', ‘3’ for Hang Tag or ‘4’ for Dumbell. If left blank, will default to ‘1’. - `lotTracking` 'N' | 'Y': Indicates (Y/N) whether the "Lot Tracking" flag is enabled, from the Company Product 'Purchasing' tab. - `masterOrderType` string: The Master Order Type associated with the Company Product. - `microcategoryName` string: The Microcategory associated with the Company Product. - `name` string, required: The Name of the Company Product. - `netWeightUnitPackageType` string: Net Weight "Unit", from the Company Product 'Optional' tab. - `netWeightUnitQuantity` number: Net Weight "Quantity", from the Company Products 'Optional' tab. - `number` string, required: The product Number for the Company Product. - `nutritionConversion` number: Indicates the number of grams in the selected Company Product 'Nutrition' unit. - `nutritionId` string: Identifies the Nutrition Product record associated with the Company Product. - `nutritionPackage` string: Identifies which Company Product Unit is used to convert nutrition data to 'grams'. - `percentageAlcohol` number: Percentage Of Alcohol, from the Company Product 'Additional Attributes' tab. - `pharmaceuticalDosage` string: Pharmaceutical Dosage, from the Company Product 'Additional Attributes' tab. - `preferredBrands` string: The "Preferred Brands" field from the Company Product 'Purchasing' tab. Entries here will populate the "Product Brand" field on the Vendor Bids screen and the "Approved Brands" field on the bid sheet submitted to the vendor. - `preferredVendorUnitConversion` number: The Preferred Vendor "Conversion to Inventory Unit", from the Company Products 'Purchasing' tab. - `preferredVendorUnitPackageType` string: The Preferred Vendor "Package Type", from the Company Product 'Purchasing' tab. This should equal the number of Inventory Units in 1 Preferred Vendor 'Package Type'. - `prescriptionFlag` string: Prescription Flag, from the Company Product 'Additional Attributes' tab. - `primaryShippingType` string: Primary Shipping Type, from the Company Product 'Additional Attributes' tab. - `productType` 'A' | 'D' | 'I' | 'N': The Product Type for the Company Product. If populated, must be ‘S’ for Stock, 'N' for Non-Stock, 'A' for Sales, or 'I' for Intermediary. If left blank, will default to ‘S’. - `recipeUnitFiveConversion` number: Recipe Unit 5 "Conversion" value for the Company Product. This should equal the number of 'Recipe Unit 5' units in 1 Inventory Unit. - `recipeUnitFivePackageType` string: Recipe Unit 5 "Unit" for the Company Product. - `recipeUnitFourConversion` number: Recipe Unit 4 "Conversion" value for the Company Product. This should equal the number of 'Recipe Unit 4' units in 1 Inventory Unit. - `recipeUnitFourPackageType` string: Recipe Unit 4 "Unit" for the Company Product. - `recipeUnitOneConversion` number, required: Recipe Unit 1 "Conversion" value for the Company Product. This should equal the number of 'Recipe Unit 1' units in 1 Inventory Unit. - `recipeUnitOnePackageType` string, required: Recipe Unit 1 "Unit" for the Company Product. - `recipeUnitThreeConversion` number: Recipe Unit 3 "Conversion" value for the Company Product. This should equal the number of 'Recipe Unit 3' units in 1 Inventory Unit. - `recipeUnitThreePackageType` string: Recipe Unit 3 "Unit" for the Company Product. - `recipeUnitTwoConversion` number: Recipe Unit 2 "Conversion" value for the Company Product. This should equal the number of 'Recipe Unit 2' units in 1 Inventory Unit. - `recipeUnitTwoPackageType` string: Recipe Unit 2 "Unit" for the Company Product. - `secondaryShippingType` string: Secondary Shipping Type, from the Company Product 'Additional Attributes' tab. - `shelfLifeIssue` integer: Indicates the number of Shelf Life days for Issue transactions, from the Company Product 'Optional' tab. - `shelfLifeReceive` integer: Indicates the number of Shelf Life days for Receive transactions, from the Company Product 'Optional' tab. - `shipLocations` CompanyProductEnhancedShipLocationDetailDto[] - `activeFlag` 'N' | 'Y': Flag to indicate (Y/N) whether the Ship Location record is Active. If populated, must be ‘Y’ or ‘N’. If left blank, will default to ‘Y’. - `locationName` string, required: The Name for an existing Ship Location. - `specialSizeUnit` number: Special Size Unit (L), from the Company Product 'Additional Attributes' tab. - `stateOfOrigin` string: Region of Origin, from the Company Product 'Additional Attributes' tab. - `statisticItemNumber` string: Statistic Item Number, from the Company Product 'Additional Attributes' tab. - `subcategoryName` string: Subcategory for the Company Product. - `substituteProductOne` string: Substitution Product 1, from the Company Product 'Optional' tab. Can be selected during the Picklisting or Invoicing stage of a Net-Chef Commissary/Customer Order if there isn't enough of the primary product on-hand. - `substituteProductTwo` string: Substitution Product 2, from the Company Product 'Optional' tab. Can be selected during the Picklisting or Invoicing stage of a Net-Chef Commissary/Customer Order if there isn't enough of the primary product on-hand. - `taxCode` string: Tax Code associated with the product, from the Company Product 'Purchasing' tab. - `temperature` number: Indicates the temperature the product should be when received. Required when the "Validate Temperature" flag = 'Y'. - `temperatureOperation` '1' | '2' | '3' | '4': Indicates the Temperature Operation for the product. If populated, must be ‘1’ (>), ‘2’ (≥), ‘3’ (≤), or ‘4’ (<). Required when the "Validate Temperature" flag = 'Y'. - `temperatureRequired` 'N' | 'Y': The "Validate Temperature" flag for the product. Indicates (Y/N) whether this is required when receiving vendor orders in Net-Chef. If left blank, will default to ‘N’. - `theoreticalEqualsActual` 'N' | 'Y': The "Set Theoretical Equal to Actual" flag, from the Company Product 'Optional' tab. If populated, must be ‘Y’ or ‘N’. If left blank, will default to ‘N’. - `therapeuticCode` string: Therapeutic Code, from the Company Product 'Additional Attributes' tab. - `universalProductCode` string: The "UPC" (Universal Product Code) for the Company Product. - `universalProductNumber` string: The Universal Product Number for the Company Product. - `universalProductUnitConversion` number: The Universal Product Unit "Conversion" for the Company Product. This should equal the number of 'Universal Product Units' in 1 Inventory Unit. - `universalProductUnitInverted` 'N' | 'Y': Flag to indicate (Y/N) whether the Universal Product Unit conversion equation should be inverted. If 'Y', this should equal the number of Inventory Units in 1 'Universal Product Unit'. - `universalProductUnitPackageType` string: The Universal Product Unit "Unit" for the Company Product. - `userDefinedCategories` CompanyProductEnhancedUserDefinedCategoryDetailDto[] - `activeFlag` 'N' | 'Y': Flag to indicate (Y/N) whether the User Defined Category record is Active. If populated, must be ‘Y’ or ‘N’. If left blank, will default to ‘Y’. - `code` string, required: The "Short Name" for an existing User Defined Category. - `companyProductEnhancedShipLocationDetails` CompanyProductEnhancedShipLocationDetailDto[] - `activeFlag` 'N' | 'Y': Flag to indicate (Y/N) whether the Ship Location record is Active. If populated, must be ‘Y’ or ‘N’. If left blank, will default to ‘Y’. - `locationName` string, required: The Name for an existing Ship Location. - `companyProductEnhancedUpcDetails` CompanyProductEnhancedUpcDetailDto[] - `activeFlag` 'N' | 'Y': Flag to indicate (Y/N) whether the Alternate UPC record is Active. If populated, must be ‘Y’ or ‘N’. If left blank, will default to ‘Y’. - `code` string, required: The Alternate "UPC" code for the Company Product. - `companyProductEnhancedUserDefinedCategoryDetails` CompanyProductEnhancedUserDefinedCategoryDetailDto[] - `activeFlag` 'N' | 'Y': Flag to indicate (Y/N) whether the User Defined Category record is Active. If populated, must be ‘Y’ or ‘N’. If left blank, will default to ‘Y’. - `code` string, required: The "Short Name" for an existing User Defined Category. ## Other responses - `400`: Validation Error - `401`: Authorization - `500`: Unexpected Error - `503`: System under maintenance - `504`: Timeout --- [API](https://skmtc.dev/crunchtime/apis/cruise-platform.md) - [All operations](https://skmtc.dev/crunchtime/apis/cruise-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/cruise-platform/revisions/d6bb0437a907?raw)