A warehouse can be an actual warehouse, a store, or any type of stocking location or site that requires inventory tracking and management. Warehouse also serves as a dimension that can be set on transactions to expand report functionality and insight. See Define warehouses for more information.
Returns up to 100 object references from the collection with a key, ID, and link for each warehouse. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Inventory Control |
---|---|
User type | Business, CRM, Employee, Warehouse |
Permissions | List, View Warehouses |
OK
Bad Request
{- "ia::result": [
- {
- "key": "5",
- "id": "103",
- "href": "/objects/inventory-control/warehouse/5"
}, - {
- "key": "8",
- "id": "101",
- "href": "/objects/inventory-control/warehouse/8"
}, - {
- "key": "9",
- "id": "100",
- "href": "/objects/inventory-control/warehouse/9"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100
}
}
Creates a new warehouse. For a warehouse hierarchy, create the parent warehouses before adding child warehouses.
Subscription | Inventory Control |
---|---|
User type | Business |
Permissions | List, View, Add Warehouses |
id required | string Unique identifier for the warehouse. Example: "USNA1" | ||||||||||||||||
name required | string Name of the warehouse. Example: "US NA Warehouse-1" | ||||||||||||||||
required | object The geographical location of the warehouse. | ||||||||||||||||
| |||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||
isReplenishmentEnabled | boolean Default: true This property is set to Example: true | ||||||||||||||||
enableNegativeInv | boolean Default: false Set to Example: true | ||||||||||||||||
object If this warehouse is part of a hierarchy, the parent warehouse of this warehouse. | |||||||||||||||||
| |||||||||||||||||
object Employee who is responsible for the warehouse. | |||||||||||||||||
| |||||||||||||||||
object The contact for the warehouse. | |||||||||||||||||
|
Created
Bad Request
{- "id": "childId2",
- "name": "child2",
- "location": {
- "id": "1--Chicago"
}, - "parent": {
- "id": "101--Distribution Center"
}, - "manager": {
- "id": "1--Courtney, Bill"
}, - "contacts": {
- "primary": {
- "id": "Sam Smith"
}, - "shipTo": {
- "id": "Bill North"
}
}, - "status": "active",
- "isReplenishmentEnabled": true
}
{- "ia::result": {
- "key": "12",
- "id": "103",
- "href": "/objects/inventory-control/warehouse/12"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified warehouse.
Subscription | Inventory Control |
---|---|
User type | Business, CRM, Employee, Warehouse |
Permissions | List, View Warehouses |
key required | string System-assigned unique key for the warehouse. |
OK
Bad Request
{- "ia::result": {
- "key": "3",
- "name": "US NA Warehouse-1",
- "id": "USNAWA1",
- "parent": {
- "id": "US NA--1",
- "key": "22",
- "href": "/objects/inventory-control/warehouse/22"
}, - "location": {
- "id": "North America--North America",
- "key": "10",
- "href": "/objects/company-config/location/10"
}, - "manager": {
- "id": "EM 1--Aman",
- "key": "14",
- "href": "/objects/company-config/employee/14"
}, - "contacts": {
- "primary": {
- "id": "Sam Smith",
- "key": "210",
- "href": "/objects/company-config/contact/210"
}, - "shipTo": {
- "id": "Bill North",
- "key": "229",
- "href": "/objects/company-config/contact/229"
}
}, - "status": "active",
- "isReplenishmentEnabled": true,
- "enableNegativeInv": false,
- "href": "/objects/inventory-control/warehouse/15",
- "audit": {
- "createdDateTime": "2021-04-21T23:57:50Z",
- "modifiedDateTime": "2021-04-21T23:59:40Z",
- "createdBy": "1",
- "modifiedBy": "1"
}
}, - "ia::meta": {
- "totalCount": 1
}
}
Updates an existing warehouse by setting field values. Any fields not provided remain unchanged.
Subscription | Inventory Control |
---|---|
User type | Business |
Permissions | List, View, Edit Warehouses |
key required | string System-assigned unique key for the warehouse. |
name | string Name of the warehouse. Example: "US NA Warehouse-1" | ||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||||||
isReplenishmentEnabled | boolean Default: true This property is set to Example: true | ||||||||||||||||
enableNegativeInv | boolean Default: false Set to Example: true | ||||||||||||||||
object The geographical location of the warehouse. | |||||||||||||||||
| |||||||||||||||||
object If this warehouse is part of a hierarchy, the parent warehouse of this warehouse. | |||||||||||||||||
| |||||||||||||||||
object Employee who is responsible for the warehouse. | |||||||||||||||||
| |||||||||||||||||
object The contact for the warehouse. | |||||||||||||||||
|
OK
Bad Request
{- "manager": {
- "id": "2--Lapus, Alan"
}
}
{- "ia::result": {
- "key": "9",
- "id": "US NA Warehouse-2",
- "href": "/objects/inventory-control/warehouse/9"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a warehouse.
Subscription | Inventory Control |
---|---|
User type | Business |
Permissions | List, View, Delete Warehouses |
key required | string System-assigned unique key for the warehouse. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "inventory-control/warehouse" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "inventory-control/warehouse",
- "filters": [
- {
- "$eq": {
- "status": "active"
}
}
], - "fields": [
- "key",
- "id",
- "name",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "2",
- "id": "Distribution",
- "name": "Distribution center",
- "href": "/objects/inventory-control/warehouse/2"
}, - {
- "key": "1",
- "id": "WS000",
- "name": "Fulfillment center",
- "href": "/objects/inventory-control/warehouse/1"
}, - {
- "key": "4",
- "id": "WS001",
- "name": "Texas warehouse",
- "href": "/objects/inventory-control/warehouse/4"
}, - {
- "key": "5",
- "id": "WS002",
- "name": "CA warehouse",
- "href": "/objects/inventory-control/warehouse/5"
}
], - "ia::meta": {
- "totalCount": 4,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}