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
    }
}
Query item warehouse vendors
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "inventory-control/item-warehouse-vendor"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or has (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "inventory-control/item-warehouse-vendor",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "vendor.id",
    • "itemWarehouse.id",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "21",
      • "id": "21",
      • "vendor.id": "CPU",
      • "itemWarehouse.id": "IWH001",
      • "href": "/objects/inventory-control/item-warehouse-vendor/21"
      },
    • {
      • "key": "22",
      • "id": "22",
      • "vendor.id": "RCB",
      • "itemWarehouse.id": "IWH002",
      • "href": "/objects/inventory-control/item-warehouse-vendor/22"
      },
    • {
      • "key": "23",
      • "id": "23",
      • "vendor.id": "RCB",
      • "itemWarehouse.id": "IWH003",
      • "href": "/objects/inventory-control/item-warehouse-vendor/23"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}