InventoryPro

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

{
  "wID": 1,
  "warehouse": "Main",
  "address": "100 Warehouse Dr",
  "city": "Springfield",
  "state": "IL",
  "zip": "62701",
  "country": "US",
  "phone": "555-0400",
  "active": true
}
FieldTypeDescription
wIDintegerUnique warehouse identifier
warehousestringWarehouse name
addressstringStreet address
citystringCity
statestringState or province
zipstringPostal code
countrystringCountry code
phonestringPhone number
activebooleanfalse when the warehouse is inactive

List Warehouses

GET /Warehouse

Returns warehouses with standard pagination parameters.

{
  "value": [
    {
      "wID": 1,
      "warehouse": "Main",
      "address": "100 Warehouse Dr",
      "city": "Springfield",
      "state": "IL",
      "zip": "62701",
      "country": "US",
      "phone": "555-0400",
      "active": true
    },
    {
      "wID": 2,
      "warehouse": "North Annex",
      "address": "450 Industrial Pkwy",
      "city": "Springfield",
      "state": "IL",
      "zip": "62704",
      "country": "US",
      "phone": "555-0450",
      "active": true
    }
  ],
  "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
{
  "wID": 1,
  "warehouse": "Main",
  "address": "100 Warehouse Dr",
  "city": "Springfield",
  "state": "IL",
  "zip": "62701",
  "country": "US",
  "phone": "555-0400",
  "active": true
}

Permissions

ActionPermission
List / GetWarehouses List (SecurityID 113)

On this page