REL documentation
properties facility (http://api.3plcentral.com/rels/properties/facility)
Resource:
a facility or warehouse within the 3pl having separate address and policies from other facilities
C# Rel Const:
Rels.PropertySvc.Facility
URI template:
facilities/{id}
Obtain URI from:
/rels/customers/charges , /rels/customers/customer , /rels/customers/customersummary , /rels/customers/itemizedchargeslist , /rels/inventory/adjustment , /rels/inventory/assembly , /rels/inventory/item , /rels/inventory/inventoryreduction , /rels/inventory/pallet , /rels/inventory/purchaseorder , /rels/inventory/receiveritem , /rels/inventory/receiver , /rels/inventory/receiverdigests , /rels/inventory/receiversummaries , /rels/orders/order , /rels/orders/digests , /rels/properties/facilitysummary , /rels/properties/location
Success status: 200; ETag response header supplied; Response is cacheable
Name (* = required) Data Type Description
id * int
Type Description
FacilityId int
Name string
Deactivated bool
UsePredefinedLocations bool? ...
Code string
UpsAccount string
FedExAccount string
FuelSurcharge decimal
LocationFieldCount int
MeasurementSystemDefault Byte 0 = USImperial, 1 = Metric
LastCloseDate DateTime? ...
FreightRateLocationCode string
TimeZoneName string domain defined by Windows TimeZoneInfo.Id (shared with Linux ICU and macOs); any of the following with " Standard Time" appended: Afghanistan, Alaskan, Aleutian, Altai, Arab, Arabian, Arabic, Argentina, Astrakhan, Atlantic, AUS Central, Aus Central W., AUS Eastern, Azerbaijan, Azores, Bahia, Bangladesh, Belarus, Bougainville, Canada Central, Cape Verde, Caucasus, Cen. Australia, Central, Central America, Central Asia, Central Brazilian, Central Europe, Central European, Central Pacific, Chatham Islands, China, Cuba, Dateline, E. Africa, E. Australia, E. Europe, E. South America, Easter Island, Eastern, Egypt, Ekaterinburg, Fiji, FLE, Georgian, GMT, Greenland, Greenwich, GTB, Haiti, Hawaiian, India, Iran, Israel, Jordan, Kaliningrad, Kamchatka, Korea, Libya, Line Islands, Lord Howe, Magadan, Magallanes, Marquesas, Mauritius, Mid-Atlantic, Middle East, Montevideo, Morocco, Mountain, Myanmar, N. Central Asia, Namibia, Nepal, New Zealand, Newfoundland, Norfolk, North Asia, North Asia East, North Korea, Omsk, Pacific, Pacific SA, Pakistan, Paraguay, Romance, Russian, SA Eastern, SA Pacific, SA Western, Saint Pierre, Sakhalin, Samoa, Sao Tome, Saratov, SE Asia, Singapore, South Africa, Sri Lanka, Sudan, Syria, Taipei, Tasmania, Tocantins, Tokyo, Tomsk, Tonga, Transbaikal, Turkey, Turks And Caicos, Ulaanbaatar, US Eastern, US Mountain, Venezuela, Vladivostok, Volgograd, W. Australia, W. Central Africa, W. Europe, W. Mongolia, West Asia, West Bank, West Pacific, Yakutsk; plus any of the following as is: Central Standard Time (Mexico), Eastern Standard Time (Mexico), Mountain Standard Time (Mexico), Pacific Standard Time (Mexico), Russia Time Zone 10, Russia Time Zone 11, Russia Time Zone 3, UTC, UTC+12, UTC+13, UTC-02, UTC-08, UTC-09, UTC-11
ShippingZip string
Contact Generic.Models.ContactInfo in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact
ContactId int? ... for identifying: if known specify only this; other fields are ignored
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsAddressResidential bool
Code string for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
PreventPartialOrderManualAllocation bool true: when doing batch manual allocation of selected orders, will skip orders not fully allocatable
Replenishment bool
ReplenishFewestLocations bool
Links IList<WebApi.Hal.Link>
- edit
- /rels/properties/facilitysummary
- /rels/properties/locationsbyfac
- /rels/properties/recentstocklocations
- /rels/properties/currentstocklocations
- /rels/properties/facilitiesactivate
- /rels/inventory/audits
- /rels/inventory/auditadjust
- /rels/inventory/locations
- /rels/properties/facilitycarrieraccounts Used for small parcel shipping.
- /rels/inventory/pallets
- /rels/properties/contact
Sample accept: application/hal+json
{
  "facilityId": 1,
  "name": "str",
  "deactivated": true,
  "usePredefinedLocations": true,
  "code": "str",
  "upsAccount": "str",
  "fedExAccount": "str",
  "fuelSurcharge": 7.0,
  "locationFieldCount": 8,
  "measurementSystemDefault": 64,
  "lastCloseDate": "2016-12-25T23:00:00",
  "freightRateLocationCode": "str",
  "timeZoneName": "str",
  "shippingZip": "str",
  "contact": {
    "contactId": 1,
    "companyName": "str",
    "name": "str",
    "title": "str",
    "address1": "str",
    "address2": "str",
    "city": "str",
    "state": "str",
    "zip": "str",
    "country": "str",
    "phoneNumber": "str",
    "fax": "str",
    "emailAddress": "str",
    "dept": "str",
    "isAddressResidential": true,
    "code": "str",
    "addressStatus": 0
  },
  "preventPartialOrderManualAllocation": true,
  "rowVersion": "str",
  "replenishment": true,
  "replenishFewestLocations": true
}
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int
Type Description
FacilityId int
Name string
Deactivated bool
UsePredefinedLocations bool? ...
Code string
UpsAccount string
FedExAccount string
FuelSurcharge decimal
LocationFieldCount int
MeasurementSystemDefault Byte 0 = USImperial, 1 = Metric
LastCloseDate DateTime? ...
FreightRateLocationCode string
TimeZoneName string domain defined by Windows TimeZoneInfo.Id (shared with Linux ICU and macOs); any of the following with " Standard Time" appended: Afghanistan, Alaskan, Aleutian, Altai, Arab, Arabian, Arabic, Argentina, Astrakhan, Atlantic, AUS Central, Aus Central W., AUS Eastern, Azerbaijan, Azores, Bahia, Bangladesh, Belarus, Bougainville, Canada Central, Cape Verde, Caucasus, Cen. Australia, Central, Central America, Central Asia, Central Brazilian, Central Europe, Central European, Central Pacific, Chatham Islands, China, Cuba, Dateline, E. Africa, E. Australia, E. Europe, E. South America, Easter Island, Eastern, Egypt, Ekaterinburg, Fiji, FLE, Georgian, GMT, Greenland, Greenwich, GTB, Haiti, Hawaiian, India, Iran, Israel, Jordan, Kaliningrad, Kamchatka, Korea, Libya, Line Islands, Lord Howe, Magadan, Magallanes, Marquesas, Mauritius, Mid-Atlantic, Middle East, Montevideo, Morocco, Mountain, Myanmar, N. Central Asia, Namibia, Nepal, New Zealand, Newfoundland, Norfolk, North Asia, North Asia East, North Korea, Omsk, Pacific, Pacific SA, Pakistan, Paraguay, Romance, Russian, SA Eastern, SA Pacific, SA Western, Saint Pierre, Sakhalin, Samoa, Sao Tome, Saratov, SE Asia, Singapore, South Africa, Sri Lanka, Sudan, Syria, Taipei, Tasmania, Tocantins, Tokyo, Tomsk, Tonga, Transbaikal, Turkey, Turks And Caicos, Ulaanbaatar, US Eastern, US Mountain, Venezuela, Vladivostok, Volgograd, W. Australia, W. Central Africa, W. Europe, W. Mongolia, West Asia, West Bank, West Pacific, Yakutsk; plus any of the following as is: Central Standard Time (Mexico), Eastern Standard Time (Mexico), Mountain Standard Time (Mexico), Pacific Standard Time (Mexico), Russia Time Zone 10, Russia Time Zone 11, Russia Time Zone 3, UTC, UTC+12, UTC+13, UTC-02, UTC-08, UTC-09, UTC-11
ShippingZip string
Contact Generic.Models.ContactInfo in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact
ContactId int? ... for identifying: if known specify only this; other fields are ignored
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsAddressResidential bool
Code string for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
PreventPartialOrderManualAllocation bool true: when doing batch manual allocation of selected orders, will skip orders not fully allocatable
Replenishment bool
ReplenishFewestLocations bool
Sample content-type: application/hal+json
 
{
  "facilityId": 1,
  "name": "str",
  "deactivated": true,
  "usePredefinedLocations": true,
  "code": "str",
  "upsAccount": "str",
  "fedExAccount": "str",
  "fuelSurcharge": 7.0,
  "locationFieldCount": 8,
  "measurementSystemDefault": 64,
  "lastCloseDate": "2016-12-25T23:00:00",
  "freightRateLocationCode": "str",
  "timeZoneName": "str",
  "shippingZip": "str",
  "contact": {
    "contactId": 1,
    "companyName": "str",
    "name": "str",
    "title": "str",
    "address1": "str",
    "address2": "str",
    "city": "str",
    "state": "str",
    "zip": "str",
    "country": "str",
    "phoneNumber": "str",
    "fax": "str",
    "emailAddress": "str",
    "dept": "str",
    "isAddressResidential": true,
    "code": "str",
    "addressStatus": 0
  },
  "preventPartialOrderManualAllocation": true,
  "rowVersion": "str",
  "replenishment": true,
  "replenishFewestLocations": true
}
Type Description
FacilityId int
Name string
Deactivated bool
UsePredefinedLocations bool? ...
Code string
UpsAccount string
FedExAccount string
FuelSurcharge decimal
LocationFieldCount int
MeasurementSystemDefault Byte 0 = USImperial, 1 = Metric
LastCloseDate DateTime? ...
FreightRateLocationCode string
TimeZoneName string domain defined by Windows TimeZoneInfo.Id (shared with Linux ICU and macOs); any of the following with " Standard Time" appended: Afghanistan, Alaskan, Aleutian, Altai, Arab, Arabian, Arabic, Argentina, Astrakhan, Atlantic, AUS Central, Aus Central W., AUS Eastern, Azerbaijan, Azores, Bahia, Bangladesh, Belarus, Bougainville, Canada Central, Cape Verde, Caucasus, Cen. Australia, Central, Central America, Central Asia, Central Brazilian, Central Europe, Central European, Central Pacific, Chatham Islands, China, Cuba, Dateline, E. Africa, E. Australia, E. Europe, E. South America, Easter Island, Eastern, Egypt, Ekaterinburg, Fiji, FLE, Georgian, GMT, Greenland, Greenwich, GTB, Haiti, Hawaiian, India, Iran, Israel, Jordan, Kaliningrad, Kamchatka, Korea, Libya, Line Islands, Lord Howe, Magadan, Magallanes, Marquesas, Mauritius, Mid-Atlantic, Middle East, Montevideo, Morocco, Mountain, Myanmar, N. Central Asia, Namibia, Nepal, New Zealand, Newfoundland, Norfolk, North Asia, North Asia East, North Korea, Omsk, Pacific, Pacific SA, Pakistan, Paraguay, Romance, Russian, SA Eastern, SA Pacific, SA Western, Saint Pierre, Sakhalin, Samoa, Sao Tome, Saratov, SE Asia, Singapore, South Africa, Sri Lanka, Sudan, Syria, Taipei, Tasmania, Tocantins, Tokyo, Tomsk, Tonga, Transbaikal, Turkey, Turks And Caicos, Ulaanbaatar, US Eastern, US Mountain, Venezuela, Vladivostok, Volgograd, W. Australia, W. Central Africa, W. Europe, W. Mongolia, West Asia, West Bank, West Pacific, Yakutsk; plus any of the following as is: Central Standard Time (Mexico), Eastern Standard Time (Mexico), Mountain Standard Time (Mexico), Pacific Standard Time (Mexico), Russia Time Zone 10, Russia Time Zone 11, Russia Time Zone 3, UTC, UTC+12, UTC+13, UTC-02, UTC-08, UTC-09, UTC-11
ShippingZip string
Contact Generic.Models.ContactInfo in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact
ContactId int? ... for identifying: if known specify only this; other fields are ignored
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsAddressResidential bool
Code string for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
PreventPartialOrderManualAllocation bool true: when doing batch manual allocation of selected orders, will skip orders not fully allocatable
Replenishment bool
ReplenishFewestLocations bool
Links IList<WebApi.Hal.Link>
- edit
- /rels/properties/facilitysummary
- /rels/properties/locationsbyfac
- /rels/properties/recentstocklocations
- /rels/properties/currentstocklocations
- /rels/properties/facilitiesactivate
- /rels/inventory/audits
- /rels/inventory/auditadjust
- /rels/inventory/locations
- /rels/properties/facilitycarrieraccounts Used for small parcel shipping.
- /rels/inventory/pallets
- /rels/properties/contact
Sample accept: application/hal+json
{
  "facilityId": 1,
  "name": "str",
  "deactivated": true,
  "usePredefinedLocations": true,
  "code": "str",
  "upsAccount": "str",
  "fedExAccount": "str",
  "fuelSurcharge": 7.0,
  "locationFieldCount": 8,
  "measurementSystemDefault": 64,
  "lastCloseDate": "2016-12-25T23:00:00",
  "freightRateLocationCode": "str",
  "timeZoneName": "str",
  "shippingZip": "str",
  "contact": {
    "contactId": 1,
    "companyName": "str",
    "name": "str",
    "title": "str",
    "address1": "str",
    "address2": "str",
    "city": "str",
    "state": "str",
    "zip": "str",
    "country": "str",
    "phoneNumber": "str",
    "fax": "str",
    "emailAddress": "str",
    "dept": "str",
    "isAddressResidential": true,
    "code": "str",
    "addressStatus": 0
  },
  "preventPartialOrderManualAllocation": true,
  "rowVersion": "str",
  "replenishment": true,
  "replenishFewestLocations": true
}
If-Match request header required; Success status: 204
Name (* = required) Data Type Description
id * int

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.