properties location (http://api.3plcentral.com/rels/properties/location)
Resource:
a storage spot within a facility
C# Rel Const:
Rels.PropertySvc.Location
URI template:
facilities/{id}/locations/{lid}
Get a location
Success status: 200; ETag response header supplied; Response is cacheable
Name (* = required) Data Type Description
id * int facility id
lid * int location id
Type Description
AllocationPriority int
Field1 string Required
Field2 string
Field3 string
Field4 string
Description string
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
LocationTypeIdentifier Generic.Models.LocationTypeIdentifier
Name string
Id int
LocationBillingTypeIdentifier Generic.Models.LocationBillingTypeIdentifier
Name string
Id int
Quarantinable bool
Height decimal? ...
Width decimal? ...
Length decimal? ...
WeightAllowed decimal? ...
TemperatureMinimum decimal? ...
QuantityMinimum decimal? ...
Zones string
PercentFill decimal? ...
StoreOnlyPallets bool
NumberPalletsAllowed int? ...
LastCountedDate DateTime? ... read-only; date when location was last counted in an inventory audit
QuantityMax decimal? ...
NonPickable bool
ReplenishLocation bool
ReplenishmentEnabled bool
PickPath int? ...
LocationId int
Name string
Deactivated bool
HasInventory bool
Sample accept: application/hal+json
{
  "allocationPriority": 1,
  "field1": "str",
  "field2": "str",
  "field3": "str",
  "field4": "str",
  "description": "str",
  "facilityIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationBillingTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "quarantinable": true,
  "height": 1.0,
  "width": 1.0,
  "length": 1.0,
  "weightAllowed": 1.0,
  "temperatureMinimum": 1.0,
  "quantityMinimum": 1.0,
  "zones": "str",
  "percentFill": 1.0,
  "storeOnlyPallets": true,
  "numberPalletsAllowed": 1,
  "lastCountedDate": "2016-12-25T23:00:00",
  "quantityMax": 1.0,
  "rowVersion": "str",
  "nonPickable": true,
  "replenishLocation": true,
  "replenishmentEnabled": true,
  "pickPath": 1,
  "locationId": 15,
  "name": "str",
  "deactivated": true,
  "hasInventory": true
}
Update a location
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int facility id
lid * int location id
Type Description
AllocationPriority int
Field1 string Required
Field2 string
Field3 string
Field4 string
Description string
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
LocationTypeIdentifier Generic.Models.LocationTypeIdentifier
Name string
Id int
LocationBillingTypeIdentifier Generic.Models.LocationBillingTypeIdentifier
Name string
Id int
Quarantinable bool
Height decimal? ...
Width decimal? ...
Length decimal? ...
WeightAllowed decimal? ...
TemperatureMinimum decimal? ...
QuantityMinimum decimal? ...
Zones string
PercentFill decimal? ...
StoreOnlyPallets bool
NumberPalletsAllowed int? ...
LastCountedDate DateTime? ... read-only; date when location was last counted in an inventory audit
QuantityMax decimal? ...
NonPickable bool
ReplenishLocation bool
ReplenishmentEnabled bool
PickPath int? ...
LocationId int
Name string
Deactivated bool
HasInventory bool
Sample content-type: application/hal+json
{
  "allocationPriority": 1,
  "field1": "str",
  "field2": "str",
  "field3": "str",
  "field4": "str",
  "description": "str",
  "facilityIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationBillingTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "quarantinable": true,
  "height": 1.0,
  "width": 1.0,
  "length": 1.0,
  "weightAllowed": 1.0,
  "temperatureMinimum": 1.0,
  "quantityMinimum": 1.0,
  "zones": "str",
  "percentFill": 1.0,
  "storeOnlyPallets": true,
  "numberPalletsAllowed": 1,
  "lastCountedDate": "2016-12-25T23:00:00",
  "quantityMax": 1.0,
  "rowVersion": "str",
  "nonPickable": true,
  "replenishLocation": true,
  "replenishmentEnabled": true,
  "pickPath": 1,
  "locationId": 15,
  "name": "str",
  "deactivated": true,
  "hasInventory": true
}
Type Description
AllocationPriority int
Field1 string Required
Field2 string
Field3 string
Field4 string
Description string
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
LocationTypeIdentifier Generic.Models.LocationTypeIdentifier
Name string
Id int
LocationBillingTypeIdentifier Generic.Models.LocationBillingTypeIdentifier
Name string
Id int
Quarantinable bool
Height decimal? ...
Width decimal? ...
Length decimal? ...
WeightAllowed decimal? ...
TemperatureMinimum decimal? ...
QuantityMinimum decimal? ...
Zones string
PercentFill decimal? ...
StoreOnlyPallets bool
NumberPalletsAllowed int? ...
LastCountedDate DateTime? ... read-only; date when location was last counted in an inventory audit
QuantityMax decimal? ...
NonPickable bool
ReplenishLocation bool
ReplenishmentEnabled bool
PickPath int? ...
LocationId int
Name string
Deactivated bool
HasInventory bool
Sample accept: application/hal+json
{
  "allocationPriority": 1,
  "field1": "str",
  "field2": "str",
  "field3": "str",
  "field4": "str",
  "description": "str",
  "facilityIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationBillingTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "quarantinable": true,
  "height": 1.0,
  "width": 1.0,
  "length": 1.0,
  "weightAllowed": 1.0,
  "temperatureMinimum": 1.0,
  "quantityMinimum": 1.0,
  "zones": "str",
  "percentFill": 1.0,
  "storeOnlyPallets": true,
  "numberPalletsAllowed": 1,
  "lastCountedDate": "2016-12-25T23:00:00",
  "quantityMax": 1.0,
  "rowVersion": "str",
  "nonPickable": true,
  "replenishLocation": true,
  "replenishmentEnabled": true,
  "pickPath": 1,
  "locationId": 15,
  "name": "str",
  "deactivated": true,
  "hasInventory": true
}
Delete a location
If-Match request header required; Success status: 204
Name (* = required) Data Type Description
id * int facility id
lid * int location id

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.