v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Company Product Enhanced Service

saveCompanyProductEnhancedV1

Create a new product. Update an existing product's details.

post/companyproduct/v1/saveCompanyProductsEnhanced

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.

Request body

Example request

{
  "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"
    }
  ]
}

Response

Success (If Automatically Create Company Product Number preference is OFF then success response is empty otherwise auto generated product number with name is returned )

namestring required

The Product Name for the Company Product.

numberstring required

The Product Number for the Company Product.

Example response

[
  {
    "name": "Test Product-1",
    "number": "PRD-17039"
  }
]