Rel doc - Rel

GET

/properties/facilities/locations{?pgsiz,pgnum,rql,sort,beginlocationid,endlocationid}

Get location collection
Success status: 200; Response is cacheable

Params
Response body (Property.Models.LocationList)

Name	Data Type	Description
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
beginlocationid	int	DEPRECATED; DON'T USE; the first location to return from the sorted list; overrides pgsiz
endlocationid	int	DEPRECATED; DON'T USE; the last location to return from the sorted list; overrides pgsiz

	Type	Description
TotalResults	int
ResourceList	IList<Property.Models.Location>
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
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/properties/locationsactivatebyfac
	- /rels/properties/facility
Links	IList<WebApi.Hal.Link>
	- next
	- prev

Sample accept: application/hal+json

{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/properties/location": [
      {
        "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
      }
    ]
  }
}

PUT

/properties/facilities/locations

Update a list of locations
Success status: 204

Params
Request body (Property.Models.LocationList)

none

	Type	Description
TotalResults	int
ResourceList	IList<Property.Models.Location>
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
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/properties/locationsactivatebyfac
	- /rels/properties/facility

Sample content-type: application/hal+json

{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/properties/location": [
      {
        "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

/properties/facilities/locations{?rql}

Delete a selection of locations
Success status: 204

Params

Name (* = required)	Data Type	Description
rql *	string	see RQL documentation

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.