Skip to main content

Update Product Supplier Inventory

PATCH 

/products/:lookupkey/:key/inventory/supplier

This endpoint allows updating supplier inventory data for a product based on a lookup key.

Available fields

NameRequired
quantity (integer)no
supplier (string)no
Default value is product supplier
warehouseId (integer)no
Default value is 0
company (InventoryCompanyUsergroupResource)no
usergroup (InventoryCompanyUsergroupResource)no
location (string)no
Default value is empty
costPrice (integer)no
Default value is product costprice
nextDeliveryDate (date)no
notes (string)no

dateModified is always updated with the current date and time.

Inventory will be updated if record is found, matching on: product supplierCode, supplier, warehouseId and location. Error is thrown if record can't be found.

Fields supplier, warehouseId and location can't be updated, used only to find the correct inventory record.

Request

Path Parameters

    lookupkey stringrequired

    Available lookup keys: id, sourceId, sku, supplierCode

    key stringrequired

    Lookup key value

Body

    costPrice number
    location string
    nextDeliveryDate string
    notes string
    quantity number
    supplier string

    usergroup

    object

    id number

Responses

Update Product Supplier Inventory - 200 / Update Product Supplier Inventory for a usergroup - 200

Response Headers

  • Connection

    string

  • Content-Length

    string

  • Date

    string

  • Keep-Alive

    string

  • Return-Format

    string

Schema

    data

    object

    companyId number
    costPrice number
    dateModified string
    id number
    location string
    nextDeliveryDate string
    notes string
    productId number
    quantity number
    sku string
    supplier string
    supplierCode string
    usergroupId number
    warehouseId number
    messages string[]
    total number
Loading...