Contents
api
Warehouses
Warehouses
A warehouse represents a physical facility where inventory is stored. This endpoint is read-only; warehouse records are managed in the Desktop application.
The Warehouse Object
{
"rec": 1,
"shortId": "MAIN",
"name": "Main",
"companyName": "ACME Corporation",
"phone": "555-0400",
"fax": "555-0401",
"email": "ops@acme.com",
"contact": "Jane Smith",
"address1": "100 Warehouse Dr",
"address2": "",
"city": "Springfield",
"state": "IL",
"zip": "62701",
"country": "US",
"region": 1,
"billTo": true,
"shipTo": true,
"shipFrom": true,
"modified": "2025-01-01T00:00:00"
}| Field | Type | Description |
|---|---|---|
rec | integer | Unique warehouse identifier |
shortId | string | Warehouse short code |
name | string | Warehouse name |
companyName | string | Company name |
phone | string | Phone number |
fax | string | Fax number |
email | string | Email address |
contact | string | Contact name |
address1 | string | Street address |
address2 | string | Secondary address line |
city | string | City |
state | string | State or province |
zip | string | Postal code |
country | string | Country code |
region | integer | Region code |
billTo | boolean | Whether the warehouse can be a bill-to |
shipTo | boolean | Whether the warehouse can be a ship-to |
shipFrom | boolean | Whether the warehouse can ship from |
modified | datetime | Last modified timestamp |
Note: The single-warehouse response (
GET /Warehouse/{id}) addsloadingDaysandstagingDays.
List Warehouses
GET /WarehouseReturns warehouses with standard pagination parameters.
{
"value": [
{
"rec": 1,
"shortId": "MAIN",
"name": "Main",
"companyName": "ACME Corporation",
"phone": "555-0400",
"fax": "555-0401",
"email": "ops@acme.com",
"contact": "Jane Smith",
"address1": "100 Warehouse Dr",
"address2": "",
"city": "Springfield",
"state": "IL",
"zip": "62701",
"country": "US",
"region": 1,
"billTo": true,
"shipTo": true,
"shipFrom": true,
"modified": "2025-01-01T00:00:00"
},
{
"rec": 2,
"shortId": "NORTH",
"name": "North Annex",
"companyName": "ACME Corporation",
"phone": "555-0450",
"fax": "555-0451",
"email": "north@acme.com",
"contact": "Tom Briggs",
"address1": "450 Industrial Pkwy",
"address2": "",
"city": "Springfield",
"state": "IL",
"zip": "62704",
"country": "US",
"region": 1,
"billTo": false,
"shipTo": true,
"shipFrom": true,
"modified": "2025-01-01T00:00:00"
}
],
"totalCount": 4,
"page": 1,
"pageSize": 25,
"pageCount": 1,
"hasMore": false
}Get a Warehouse
GET /Warehouse/{id}Returns 404 if the warehouse does not exist.
GET /Warehouse/1{
"rec": 1,
"shortId": "MAIN",
"name": "Main",
"companyName": "ACME Corporation",
"phone": "555-0400",
"fax": "555-0401",
"email": "[EMAIL]",
"contact": "Jane Smith",
"address1": "100 Warehouse Dr",
"address2": "",
"city": "Springfield",
"state": "IL",
"zip": "62701",
"country": "US",
"region": 1,
"billTo": true,
"shipTo": true,
"shipFrom": true,
"loadingDays": 0,
"stagingDays": 0,
"modified": "2025-01-01T00:00:00"
}List Warehouse Items
GET /Warehouse/{id}/ItemsLists items linked to a warehouse (ItemID, Description). Supports the standard pagination envelope; sort/direction and modifiedSince are not supported on this endpoint.
Permissions
| Action | Permission |
|---|---|
| List / Get | Warehouses List (SecurityID 113) |
On this page