Item warehouse vendors

Use this object to specify the vendor information you want to use in the replenishment calculations for the item in this warehouse.

List item warehouse vendors

get/objects/inventory-control/item-warehouse-vendor

Returns a collection with a key, ID, and link for each item warehouse vendor.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "21",
      • "id": "21",
      • "href": "/objects/inventory-control/item-warehouse-vendor/21"
      },
    • {
      • "key": "22",
      • "id": "22",
      • "href": "/objects/inventory-control/item-warehouse-vendor/22"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100
    }
}
Create an item warehouse vendor
post/objects/inventory-control/item-warehouse-vendor
Creates a new item warehouse vendor.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
required
object
The vendor to use in the replenishment calculations for the item in this warehouse.


 
key
string  <= 8 characters 
System generated Vendor Key


 
 Example:  "38"
id
string  <= 20 characters 
User sepcified Vendor ID


 
 Example:  "Office_Supplies"
object
The item warehouse combination that can be ordered from the vendor.


 
 Example:  {"itemWarehouse":{"key":"649"}}
key
required
string  <= 8 characters 
System generated Item Warehouse Inventory Key


 
 Example:  "13"
id
string  <= 8 characters 
System generated Item Warehouse Inventory ID


 
 Example:  "13"
stockNumber
string  <= 50 characters 
The stock number that vendor uses for this item.


 
 Example:  "#5678901234"
leadTime
integer  <= 3 characters 
The number of days it takes the vendor to deliver this item to you after receiving the order.


 
 Example:  15
demandForecastDuringLeadTime
integer
The quantity of this item that's expected to be sold during the lead time.


 
 Example:  5
economicalOrderQuantity
integer  <= 8 characters 
The quantity that makes the cost of reordering this item the most economical.


 
 Example:  10
vendorMinimumOrderQuantity
integer  <= 8 characters 
The minimum quantity of this item the vendor is willing to sell.


 
 Example:  10
object
The units of measure detail is the vendor sells this item in.


 
key
string  <= 8 characters 
The units of measure Key


 
 Example:  "38"
id
string  <= 20 characters 
The units of measure Id.


 
 Example:  "Each"
isPreferredVendor
boolean
 Default:  false
This identify a vendor as the preferred vendor for replenishing this item for warehouse.


 
 Example:  false
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "itemWarehouse": {
    • "key": "12"
    },
  • "vendor": {
    • "key": "122"
    },
  • "stockNumber": "#5678901234",
  • "unitOfMeasure": {
    • "key": "38"
    },
  • "leadTime": 15,
  • "demandForecastDuringLeadTime": 5,
  • "economicalOrderQuantity": 10,
  • "vendorMinimumOrderQuantity": 10,
  • "isPreferredVendor": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "66",
    • "id": "66",
    • "href": "/objects/inventory-control/item-warehouse-vendor/66"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an item warehouse vendor
get/objects/inventory-control/item-warehouse-vendor/{key}
Returns detailed information for a specified item warehouse vendor.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item warehouse vendor.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "66",
    • "key": "66",
    • "itemWarehouse": {
      • "id": "76",
      • "key": "76",
      • "href": "/objects/item-warehouse-inventory/76"
      },
    • "vendor": {
      • "id": "vendorId-1702552731",
      • "key": "2387",
      • "href": "/objects/vendor/2387"
      },
    • "stockNumber": "#5678901234",
    • "leadTime": 15,
    • "demandForecastDuringLeadTime": 5,
    • "economicalOrderQuantity": 10,
    • "vendorMinimumOrderQuantity": 10,
    • "bestPrice": "112.23",
    • "latestPrice": "112.23",
    • "unitOfMeasure": {
      • "key": "38",
      • "id": "Each",
      • "href": "/objects/inventory-control/unit-of-measure/38"
      },
    • "conversionFactor": "1",
    • "isPreferredVendor": true,
    • "href": "/objects/inventory-control/item-warehouse-vendor/66"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an item warehouse vendor
patch/objects/inventory-control/item-warehouse-vendor/{key}
Updates an existing item warehouse vendor by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item warehouse vendor.


 
 Example:  99
Request Body schema: application/json
object
The item warehouse combination that can be ordered from the vendor.


 
key
string  <= 8 characters 
System generated Item Warehouse Inventory Key


 
 Example:  "13"
id
string  <= 8 characters 
System generated Item Warehouse Inventory ID


 
 Example:  "13"
object
The vendor to use in the replenishment calculations for the item in this warehouse.


 
key
string  <= 8 characters 
System generated Vendor Key


 
 Example:  "38"
id
string  <= 20 characters 
User sepcified Vendor ID


 
 Example:  "Office_Supplies"
stockNumber
string  <= 50 characters 
The stock number that vendor uses for this item.


 
 Example:  "#5678901234"
leadTime
integer  <= 3 characters 
The number of days it takes the vendor to deliver this item to you after receiving the order.


 
 Example:  15
demandForecastDuringLeadTime
integer
The quantity of this item that's expected to be sold during the lead time.


 
 Example:  5
economicalOrderQuantity
integer  <= 8 characters 
The quantity that makes the cost of reordering this item the most economical.


 
 Example:  10
vendorMinimumOrderQuantity
integer  <= 8 characters 
The minimum quantity of this item the vendor is willing to sell.


 
 Example:  10
object
The units of measure detail is the vendor sells this item in.


 
key
string  <= 8 characters 
The units of measure Key


 
 Example:  "38"
id
string  <= 20 characters 
The units of measure Id.


 
 Example:  "Each"
isPreferredVendor
boolean
 Default:  false
This identify a vendor as the preferred vendor for replenishing this item for warehouse.


 
 Example:  false
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "stockNumber": "#5678901234222",
  • "leadTime": 15,
  • "demandForecastDuringLeadTime": 5,
  • "economicalOrderQuantity": 10,
  • "vendorMinimumOrderQuantity": 10,
  • "isPreferredVendor": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "66",
    • "id": "66",
    • "href": "/objects/inventory-control/item-warehouse-vendor/66"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an item warehouse vendor
delete/objects/inventory-control/item-warehouse-vendor/{key}
Deletes an item warehouse vendor.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item warehouse vendor.


 
 Example:  99
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}