REL documentation
inventory currentlocations (http://api.3plcentral.com/rels/inventory/currentlocations)
Resource:
current inventory locations
C# Rel Const:
Rels.InventorySvc.CurrentInventoryLocations
URI template:
facilities/{id}/item/{iid}/currentlocations{?pgsiz,pgnum,rql,sort}
Obtain URI from:
Billboard
Get a specific item's current Onhand count for all existing locations within a facility
Success status: 200
Name (* = required) Data Type Description
id * int facility id
iid * int item id
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string filters initial stock before onhand location grouping; see RQL documentation
sort string defaults to descending onhand quantity if empty; see RQL documentation
Type Description
TotalResults int
ResourceList IList<Inventory.Models.CurrentInventoryLocation>
LocationIdentifier Generic.Models.LocationIdentifier facilityid, locationid, location name
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
FacilityIdentifier Generic.Models.FacilityIdentifier FacilityIdentifier of grouped location quantities
Name string
Id int
Qty decimal? ... Current OnHand Count from StockStatus
Links IList<WebApi.Hal.Link>
- /rels/properties/location
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "item": [
      {
        "locationIdentifier": {
          "nameKey": {
            "facilityIdentifier": {
              "name": "str",
              "id": 2
            },
            "name": "str"
          },
          "id": 1
        },
        "facilityIdentifier": {
          "name": "str",
          "id": 2
        },
        "qty": 1.0
      }
    ]
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.