Skip to main content

Create Product Supplier Inventory

POST 

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

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

Available fields

NameRequired
quantity (integer)yes
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.

On creating a record, inventory type supplier is matching the product on the lookup key. If the product is found, inventory record will be created.

If an inventory record is found, matching on: supplier, supplierCode, warehouseId and location, error is thrown that duplicate record can't be created.

InventoryCompanyUsergroup Resource

A InventoryCompanyUsergroup resource is a JSON object used for identifying a company or usergroup when creating company/ usergroup specific stock record. It can be identified by either an id or source/ sourceId.

{
"id": 56987
}
   "sourceId": "1",
"source": "TECHDATA",
"language": "NL"
}

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

Create Product Supplier Inventory - 201 / Create Product Supplier Inventory for a usergroup - 201

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...