Location

Location Object

The Location is a primary record type in Order Time.  

End Point

/location

GET, POST, PUT, DELETE

GET and DELETE requests expect parameter id of type Int32.

Properties

PropertyCaptionData TypeRequired
NameNameString (50)True
IdIdInt32False
Addr1Name/Company
String (50)False
Addr2
Street
String (50)
False
Addr3
Floor/Suite
String (50)
False
CityState/Prov./Reg
String (50)
False
StateState/Prov./Reg
String (50)
False
ZipZip/Postal code
String (50)
False
CountryCountry
String (50)
False
IsAvailable
AvailableBooleanTrue
IsActiveActiveBooleanTrue
CustomFieldsCustom FieldsArray of CustomFieldDataFalse
NoteNoteString(4000)False

CreditCardNo will not be returned on any GET requests.

Json Sample

{
    Id: 10,
    Name: "HQ",
    IsActive: true,
    IsAvailable: true,
    Addr1: "Peter Pan LLC",
    Addr2: "45 Hart St",
    Addr3: "Suite 5",       
    City: "NY",
    State: "NY",
    Zip: "00250",      
    Country: "US",
    Note: "",
    CustomFields: [
      {       
        Name: "LocCust1", 
        Value: "Custom field value",
      }
     ]
}