Company Product Enhanced Service
getCompanyProductsEnhancedByPage
Retrieve one or more company products by pageNumber. Use to retrieve data in smaller chunks.
get/cruise/companyproduct/v1/getCompanyProductsEnhancedByPage
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/getCompanyProductsEnhancedByPage
- Authnone declared. Required headers: authenticationtoken, password, sitename, userid
Query parameters
activeFlagboolean
Use true to retrieve only active Company Products.
includeDetailsboolean
Use true to retrieve detailed information for each Company Product.
pageNumberinteger
Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.
productNumberstring
A unique alphanumeric code used to identify a product.
includeNullboolean
Specify 'true' to output null data elements.
Headers
authenticationtokenstring required
Secure token for API authentication.
passwordstring required
Password for the Crunchtime Application User.
sitenamestring required
Crunchtime site identifier. (test or production)
useridstring required
User ID for the Crunchtime Application User.
X-B3-TraceIdstring
Optional trace identifier for troubleshooting.
Response
Success
Example response
{
"companyProductEnhancedDetails": [
{
"companyProductEnhancedAllergenAttributeDetails": [
{
"activeFlag": "Y",
"nutritionClass": "Nutrition 1",
"value": "101"
}
],
"companyProductEnhancedConceptDetails": [
{
"activeFlag": "Y",
"code": "SEAFOOD-EM"
}
],
"companyProductEnhancedDepartmentDetails": [
{
"activeFlag": "Y",
"code": "100"
}
],
"companyProductEnhancedHeaderDetails": {
"activeFlag": "Y",
"allergenAttributes": [
{
"activeFlag": "Y",
"nutritionClass": "Nutrition 1",
"value": "101"
}
],
"alternateNameFive": "Alternate Language Product Name 5",
"alternateNameFour": "Alternate Language Product Name 4",
"alternateNameOne": "Alternate Language Product Name 1",
"alternateNameThree": "Alternate Language Product Name 3",
"alternateNameTwo": "Alternate Language Product Name 2",
"alternateUnitOneConversion": 9999.9999,
"alternateUnitOnePackageType": "LB",
"alternateUnitThreeConversion": 9999.9999,
"alternateUnitThreePackageType": "LB",
"alternateUnitTwoConversion": 9999.9999,
"alternateUnitTwoPackageType": "LB",
"alternateUpcs": [
{
"activeFlag": "Y",
"code": "12300123"
}
],
"bidSheet": "Beverages",
"bonded": "Y",
"categoryName": "FOOD",
"comment": "Remarks",
"concepts": [
{
"activeFlag": "Y",
"code": "SEAFOOD-EM"
}
],
"containerVolumeUnitPackageType": "KG",
"containerVolumeUnitQuantity": 99999999.9999,
"containerWeightUnitPackageType": "KG",
"containerWeightUnitQuantity": 99999999.9999,
"countryOfOrigin": "country Of Origin",
"customsStatus": "customs Status",
"departments": [
{
"activeFlag": "Y",
"code": "100"
}
],
"governmentMinimumStock": "government Minimum Stock",
"gradPlato": 99999.99,
"haccpCompliance": "Avoid Cross Contamination",
"inventoryUnitPackageType": "LB",
"issueUnitOneConversion": 99999999.999999,
"issueUnitOnePackageType": "B-1/6 PAN",
"issueUnitTwoConversion": 99999999.999999,
"issueUnitTwoInverted": "Y",
"issueUnitTwoPackageType": "CS",
"lotTracking": "Y",
"masterOrderType": "mod",
"microcategoryName": "MARGIN",
"name": "BUTTER",
"netWeightUnitPackageType": "3 KG",
"netWeightUnitQuantity": 999.9999,
"number": "10047",
"nutritionConversion": 9999.9999,
"nutritionPackage": "INVENTORY",
"percentageAlcohol": 99999.99,
"pharmaceuticalDosage": "pharmaceutical Dosage",
"preferredBrands": "MDR",
"preferredVendorUnitConversion": 9999.9999,
"preferredVendorUnitPackageType": "PU",
"prescriptionFlag": "prescription",
"primaryShippingType": "REFRIGERATED",
"productType": "S",
"recipeUnitFiveConversion": 99999999.999999,
"recipeUnitFivePackageType": "OZ FL",
"recipeUnitFourConversion": 99999999.999999,
"recipeUnitFourPackageType": "OZ FL",
"recipeUnitOneConversion": 99999999.999999,
"recipeUnitOnePackageType": "OZ FL",
"recipeUnitThreeConversion": 99999999.999999,
"recipeUnitThreePackageType": "OZ FL",
"recipeUnitTwoConversion": 99999999.999999,
"recipeUnitTwoPackageType": "OZ FL",
"secondaryShippingType": "FROZEN",
"shelfLifeIssue": 9999,
"shelfLifeReceive": 9999,
"shipLocations": [
{
"activeFlag": "Y",
"locationName": "Excelsior"
}
],
"specialSizeUnit": 99999.99,
"stateOfOrigin": "state Of Origin",
"statisticItemNumber": "statistic ItemNumber",
"subcategoryName": "PREP",
"substituteProductOne": "Substitute Product 1",
"substituteProductTwo": "Substitute Product 2",
"temperature": 999.99,
"temperatureRequired": "Y",
"theoreticalEqualsActual": "Y",
"therapeuticCode": "therapeutic Code",
"universalProductCode": "12300123",
"universalProductNumber": "1230012",
"universalProductUnitConversion": 9999.9999,
"universalProductUnitInverted": "Y",
"universalProductUnitPackageType": "OZ FL",
"userDefinedCategories": [
{
"activeFlag": "Y",
"code": "cd 1"
}
]
},
"companyProductEnhancedShipLocationDetails": [
{
"activeFlag": "Y",
"locationName": "Excelsior"
}
],
"companyProductEnhancedUpcDetails": [
{
"activeFlag": "Y",
"code": "12300123"
}
],
"companyProductEnhancedUserDefinedCategoryDetails": [
{
"activeFlag": "Y",
"code": "cd 1"
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.