Skip to content

parts

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference

/rest/stockMgmt/parts

POST
Adds/updates a part
  • partDescription - mandatory if partNumber cannot be found (i.e. adding a new part)
  • partCategoryId - mandatory if partNumber cannot be found (i.e. adding a new part)
  • reOrderLevel - optional - defaults to 1 if not supplied and new Part is created
  • reOrderQty - optional - defaults to 1 if not supplied and new Part is created
  • uomId - optional - defaults to 0 if not supplied and new Part is created
  • preferredVendorId is optional but if provided must match an existing vendor
  • taxTypeId - optional - defaults to taxType of first Client in ClientGroup

acceptable request representations:

  • application/json
{    "parts" : [        {
            "partNumber" : "eeheh23",                "partDescription" : "12 inch nail",            "partCategoryId": "3",
            "reOrderLevel" : "3",
            "reOrderQty" : "7",            "uomId" : "1",            "unitCost" : "34.23",
            "preferredVendorId" : "212",
            "clientGroupId" : "512",
            "taxTypeId" : "0"
        }
    ]


}


available response representations:
  • 200 - application/json
{
    "result" : "success or fail",
    "result_msg" : "error message", 
    # may also return 
    "newPartId" : "8181"
}


See the Stock Management API matrix for the full list of endpoints in this category.