REL documentation
inventory locations (http://api.3plcentral.com/rels/inventory/locations)
Resource:
locations plus contents, including empty locations
C# Rel Const:
Rels.InventorySvc.Locations
URI template:
facilities/{id}/locations{?pgsiz,pgnum,rql,sort,excludeInAudit}
Obtain URI from:
/rels/properties/facility
get a facility's locations, including inventory contained in each location if any
Success status: 200
Name (* = required) Data Type Description
id * int facility 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 see RQL documentation
sort string see RQL documentation
excludeInAudit bool if true, excludes locations contained in a non-closed audit task
Type Description
TotalResults int
ResourceList IList<Inventory.Models.InventoryLocation>
LocationIdentifier Generic.Models.LocationIdentifier facilityid, locationid, location name
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
Description string
LocationTypeIdentifier Generic.Models.LocationTypeIdentifier
Name string
Id int
LastCountedDate DateTime? ... when location was last counted in an inventory audit
ItemTraits Generic.Models.ItemTraits unique identifying characteristics of an item in a location
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
LotNumber string
SerialNumber string
Cost decimal? ...
ExpirationDate DateTime? ...
PalletIdentifier Generic.Models.PalletIdentifier
NameKey Generic.Models.PalletNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
CustomerIdentifier Generic.Models.CustomerIdentifier null if ItemTraits is null
ExternalId string
Name string
Id int
OnHand decimal? ... null if ItemTraits is null
Links IList<WebApi.Hal.Link>
- /rels/properties/location
- /rels/customers/customer
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
        },
        "description": "str",
        "locationTypeIdentifier": {
          "name": "str",
          "id": 2
        },
        "lastCountedDate": "2016-12-25T23:00:00",
        "itemTraits": {
          "itemIdentifier": {
            "sku": "str",
            "id": 2
          },
          "qualifier": "str",
          "lotNumber": "str",
          "serialNumber": "str",
          "cost": 1.0,
          "expirationDate": "2016-12-25T23:00:00",
          "palletIdentifier": {
            "nameKey": {
              "facilityIdentifier": {
                "name": "str",
                "id": 2
              },
              "name": "str"
            },
            "id": 1
          }
        },
        "customerIdentifier": {
          "externalId": "str",
          "name": "str",
          "id": 3
        },
        "onHand": 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.