Warehouses

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.

List warehouses

get/objects/inventory-control/warehouse

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 the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create a warehouse
post/objects/inventory-control/warehouse
Creates a new warehouse. For a warehouse hierarchy, create the parent warehouses before adding child warehouses.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
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.


 
id
string
 
 Example:  "PHO--Phoenix"
key
string
System-assigned key for the location.


 
 Example:  "2"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
isReplenishmentEnabled
boolean
 Default:  true
This property is set to true by default if Inventory Control is configured for replenishment. If the warehouse should not be replenished, set to false.


 
 Example:  true
enableNegativeInv
boolean
 Default:  false
Set to true to save transactions that cause the inventory for items in this warehouse to be negative.


 
 Example:  true
object
If this warehouse is part of a hierarchy, the parent warehouse of this warehouse.


 
id
string
Unique identifier for the parent warehouse.


 
 Example:  "WH10001--US AZ Warehouse 10001"
key
string
System-assigned key for the parent warehouse.


 
 Example:  "32"
object
Employee who is responsible for the warehouse.


 
id
string
Unique identifier of the employee who is the warehouse manager.


 
 Example:  "EM 1--Aman"
key
string
System-assigned key for the warehouse manager.


 
 Example:  "23"
object
The contact for the warehouse.


 
object
 
id
string
Name for the warehouse contact.


 
 Example:  "Sam Smith"
key
string
System-assigned key for the warehouse contact.


 
 Example:  "210"
object
Ship to contact for the warehouse.


 
id
string
Name for the Ship to contact.


 
 Example:  "Bill North"
key
string
System-assigned key for the Ship to contact.


 
 Example:  "223"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "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
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "103",
    • "href": "/objects/inventory-control/warehouse/12"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a warehouse
get/objects/inventory-control/warehouse/{key}
Returns detailed information for a specified warehouse.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "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": {
        },
      • "shipTo": {
        }
      },
    • "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
    }
}
Update a warehouse
patch/objects/inventory-control/warehouse/{key}
Updates an existing warehouse by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  99
Request Body schema: application/json
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.


 Enum: "active" "inactive"  
 Example:  "active"
isReplenishmentEnabled
boolean
 Default:  true
This property is set to true by default if Inventory Control is configured for replenishment. If the warehouse should not be replenished, set to false.


 
 Example:  true
enableNegativeInv
boolean
 Default:  false
Set to true to save transactions that cause the inventory for items in this warehouse to be negative.


 
 Example:  true
object
The geographical location of the warehouse.


 
id
string
 
 Example:  "PHO--Phoenix"
key
string
System-assigned key for the location.


 
 Example:  "2"
object
If this warehouse is part of a hierarchy, the parent warehouse of this warehouse.


 
id
string
Unique identifier for the parent warehouse.


 
 Example:  "WH10001--US AZ Warehouse 10001"
key
string
System-assigned key for the parent warehouse.


 
 Example:  "32"
object
Employee who is responsible for the warehouse.


 
id
string
Unique identifier of the employee who is the warehouse manager.


 
 Example:  "EM 1--Aman"
key
string
System-assigned key for the warehouse manager.


 
 Example:  "23"
object
The contact for the warehouse.


 
object
 
id
string
Name for the warehouse contact.


 
 Example:  "Sam Smith"
key
string
System-assigned key for the warehouse contact.


 
 Example:  "210"
object
Ship to contact for the warehouse.


 
id
string
Name for the Ship to contact.


 
 Example:  "Bill North"
key
string
System-assigned key for the Ship to contact.


 
 Example:  "223"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "manager": {
    • "id": "2--Lapus, Alan"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "9",
    • "id": "US NA Warehouse-2",
    • "href": "/objects/inventory-control/warehouse/9"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a warehouse
delete/objects/inventory-control/warehouse/{key}
Deletes a warehouse.


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


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