API Product Documentation, Training & Roll Out

Owned by Sehrish Shafqat
Last updated: Dec 29, 2022
7 min read

By default  "productPurchaseFactorType": "PurchaseUnitsPerProductUnit" will be added 

Create Product (only required fields)

{
  "productNumber": "productNumber",
  "productData": {
    "productName": "productName"
  }
}

Create product and connect pricelist

{
  "productNumber": "Unique number",
  "productData": {
    "productName": "product API73"
  },
   "productPrices": [
    {
      "salesUnit": {
        "quantity": 1,
        "unit": "ST"
      },
      "calculateSalesUnits": false,
      "productPriceListRows": [
        {
          "priceList": "300178",
          "numberSalesUnits": 1,
          "price": 100,
          "vatPercent": 25,
          "currency": "DKK"
        }
      ]
}]}

Create Product Connect warehouse(only required fields) and Pricelist

{
  "productNumber": "Unique Number",
  "productData": {
    "productName": "product API73"
  },
    
  "productPrices": [
    {
      "salesUnit": {
        "quantity": 1,
        "unit": "ST"
      },
      "calculateSalesUnits": false,
      "productPriceListRows": [
        {
          "priceList": "300178",
          "numberSalesUnits": 1,
          "price": 100,
          "vatPercent": 25,
          "currency": "DKK"
        }
      ]
    }
  ],
  "productWarehouses": [
    {
      "warehouse": "DWarehouse",
      "inventoryManagementSource": "XLOG"
    }
  ]
}

Create Product Connect warehouse and Pricelist


{
  "productNumber": "Unique Number",
  "productData": {
    "productName": "product API73"
  },
    
  "productPrices": [
    {
      "salesUnit": {
        "quantity": 1,
        "unit": "ST"
      },
      "calculateSalesUnits": false,
      "productPriceListRows": [
        {
          "priceList": "300178",
          "numberSalesUnits": 1,
          "price": 100,
          "vatPercent": 25,
          "currency": "DKK"
        }
      ]
    }
  ],
  "productWarehouses": [
    {
      "warehouse": "DWarehouse",
      "inventoryManagementSource": "XLOG",
      "subOrderQuantity": 0,
      "reorderLevel": 0,
      "safetyStock": 0,
      "quantityRatio": 0,
      "parameterReference": "0",
      "startPrognosis": 0,
      "coverTimeStartPrognosis": 0,
      "coverTimeMargin": 0,
      "vauClass": "0",
      "minOrderQuantity": 0,
      "maxOrderQuantity": 0,
      "multipleQuantity": 0,
      "customerProductNumber": null,
      "indicationMargin": null,
      "daysToCover": 0
    }
  ]
}

Create Product , Connect Supplier agreement, Pricelist , sales unit and warehouse

{
  "productNumber": "Unique Number",
  "productData": {
    "productName": "product API73"
  },
  "productPrices": [
    {
      "salesUnit": {
        "quantity": 1,
        "unit": "ST"
      },
      "calculateSalesUnits": false,
      "productPriceListRows": [
        {
          "priceList": "300178",
          "numberSalesUnits": 1,
          "price": 100,
          "vatPercent": 25,
          "currency": "DKK"
        }
      ]
    }
  ],
  "productWarehouses": [
    {
      "warehouse": "DWarehouse",
      "inventoryManagementSource": "XLOG"
    }
  ],
  "productSuppliers": [
    {
      "supplierAgreement": "1 Enkelt Blomst",
      "supplierProductNumber": "7777",
      "supplierProductName": null,
      "StatisticalNumber": null,
      "price": 0,
      "vatPercent": 25,
      "country": "DK",
      "manufacturingLeadTimeHour": 0,
      "supplierAgreementNumber": 700697
    }
  ]
}

Create Product , Connect Supplier agreement(required info), Pricelist , sales unit and warehouse

{
  "productNumber": "Unique Number",
  "productData": {
    "productName": "product API73"
  },
  "productPrices": [
    {
      "salesUnit": {
        "quantity": 1,
        "unit": "ST"
      },
      "calculateSalesUnits": false,
      "productPriceListRows": [
        {
          "priceList": "300178",
          "numberSalesUnits": 1,
          "price": 100,
          "vatPercent": 25,
          "currency": "DKK"
        }
      ]
    }
  ],
  "productWarehouses": [
    {
      "warehouse": "DWarehouse",
      "inventoryManagementSource": "XLOG"
    }
  ],
  "productSuppliers": [
    {
      "supplierAgreement": "1 Enkelt Blomst",
      "supplierAgreementNumber": 700697
    }
  ]
}

Create Product and Connect Categories

{
  "productNumber": "Unique Number",
  "productData": {
    "productName": "product API73",
    "productGroupsAndCategories": {
      "productCategories": [
        "VISPI1806",
        "zainkazmii/hzkazmi01"
      ]
  }
  },
  
  "productPrices": [
    {
      "salesUnit": {
        "quantity": 1,
        "unit": "ST"
      },
      "calculateSalesUnits": false,
      "productPriceListRows": [
        {
          "priceList": "300178",
          "numberSalesUnits": 1,
          "price": 100,
          "vatPercent": 25,
          "currency": "DKK"
        }
      ]
    }
  ],
  "productWarehouses": [
    {
      "warehouse": "DWarehouse",
      "inventoryManagementSource": "XLOG"
    }
  ],
  "productSuppliers": [
    {
      "supplierAgreement": "1 Enkelt Blomst",
      "supplierAgreementNumber": 700697
    }
  ]
}

Create Product and add Transport , Product measurements, Warehouse, pricelist, supplier agreement

{
  "productNumber": "Unique Number",
  "productData": {
    "productName": "product API73",
    "productGroupsAndCategories": {
      "productCategories": [
        "VISPI1806",
        "zainkazmii/hzkazmi01"
      ]
  },
     "productMeasurements": {
      "length": 40,
      "width": 0,
      "height": 0,
      "weight": 0
    },
    "transportMeasurements": {
      "length": 50,
      "width": 0,
      "height": 0,
      "weight": 0
    }
  },
  
  "productPrices": [
    {
      "salesUnit": {
        "quantity": 1,
        "unit": "ST"
      },
      "calculateSalesUnits": false,
      "productPriceListRows": [
        {
          "priceList": "300178",
          "numberSalesUnits": 1,
          "price": 100,
          "vatPercent": 25,
          "currency": "DKK"
        }
      ]
    }
  ],
  "productWarehouses": [
    {
      "warehouse": "DWarehouse",
      "inventoryManagementSource": "XLOG"
    }
  ],
  "productSuppliers": [
    {
      "supplierAgreement": "1 Enkelt Blomst",
      "supplierAgreementNumber": 700697
    }
  ]
}

Create BOM Product with warehouse, pricelist, supplier agreement, Product measurements

{
  "productNumber": "BOM23432",
  "productData": {
    "productName": "product API73",
    "productServices": {
      "supplyMode": "BillOfMaterials"
    },
  
    "productGroupsAndCategories": {
      "productCategories": [
        "VISPI1806",
        "zainkazmii/hzkazmi01"
      ]
    },
    "productMeasurements": {
      "length": 30,
      "width": 0,
      "height": 0,
      "weight": 0
    },
    "transportMeasurements": {
      "length": 20,
      "width": 0,
      "height": 0,
      "weight": 0
    },
    "productTransportDetails": {
      "unNumber": "4343",
      "customsClass": "343242342",
      "customsCommodityCode": "3432432",
      "ean": "4324343544343"
    },
    "internalProductNumber": "32432434",
    "manufacturer": null,
     "billOfMaterials": [
      {
        "productNumber": "00.223",
        "quantity": 1,
        "unit": "ST",
        "sortOrder": 0,
        "partOfPricePercent": 0.2
      },
      {
        "productNumber": "0000090",
        "quantity": 1,
        "unit": "ST",
        "sortOrder": 0,
        "partOfPricePercent": 99.8
      }
    ]
  },
  "productPrices": [
    {
      "salesUnit": {
        "quantity": 1,
        "unit": "ST"
      },
      "calculateSalesUnits": false,
      "productPriceListRows": [
        {
          "priceList": "300178",
          "numberSalesUnits": 1,
          "price": 100,
          "vatPercent": 25,
          "currency": "DKK"
        }
      ]
    }
  ],
  "productWarehouses": [
    {
      "warehouse": "DWarehouse",
      "inventoryManagementSource": "XLOG"
    }
  ],
  "productSuppliers": [
    {
      "supplierAgreement": "1 Enkelt Blomst",
      "supplierProductNumber": "7777674643",
      "supplierAgreementNumber": 700697
    }
  ]
}

Create Product with main product fields

{
  "productNumber": "Unique Number",
  "productData": {
    "productName": "product API73",
    "countryOfOrigin": "SE",
    "cost": 0,
    "currency": "SEK",
    "productServices": {
      "supplyMode": "Warehouse"
    },
    "productUnit": "ST",
    "productPurchaseFactorType": "PurchaseUnitsPerProductUnit",
    "productPurchaseFactor": 1,
    "outerPackagingUnitData1": {
      "quantity": 1,
      "unit": "ST"
    },
    "outerPackagingUnitData2": null,
    "measureUnitData": {
      "quantity": 1,
      "unit": "ST"
    },
    "productGroupsAndCategories": {
      "productCategories": [
        "VISPI1806",
        "zainkazmii/hzkazmi01"
      ],
      "productFamily": null,
      "assortmentCategory": null,
      "financialCategory": null,
      "companyGroup": null,
      "warehouseZone": null,
      "vatCategory": null,
      "statisticalCategory1": null,
      "statisticalCategory2": null,
      "statisticalCategory3": null,
      "alphaSearch": null
    },
    "productMeasurements": {
      "length": 30,
      "width": 0,
      "height": 0,
      "weight": 0
    },
    "transportMeasurements": {
      "length": 20,
      "width": 0,
      "height": 0,
      "weight": 0
    },
    "productTransportDetails": {
      "unNumber": "4343",
      "customsClass": "343242342",
      "customsCommodityCode": "3432432",
      "ean": "4324343544343"
    },
    "internalProductNumber": "32432434",
    "manufacturer": null,
  
    "productProperties": [],
    "productVariants": [],
    "billOfMaterials": [],
    "productRelations": []
  },
  "productPrices": [
    {
      "salesUnit": {
        "quantity": 1,
        "unit": "ST"
      },
      "calculateSalesUnits": false,
      "productPriceListRows": [
        {
          "priceList": "300178",
          "numberSalesUnits": 1,
          "price": 100,
          "vatPercent": 25,
          "currency": "DKK"
        }
      ]
    }
  ],
  "productWarehouses": [
    {
      "warehouse": "DWarehouse",
      "inventoryManagementSource": "XLOG"
    }
  ],
  "productSuppliers": [
    {
      "supplierAgreement": "1 Enkelt Blomst",
      "supplierProductNumber": "7777674643",
      "supplierAgreementNumber": 700697
    }
  ]
}