GET v1/rental/partnerLocations/{orderType}

Settings used to determine visibility and module settings for Rental activity

Request Information

URI Parameters

Name	Description	Type	Additional information
orderType		string	Required

Body Parameters

None.

Response Information

Resource Description

LocationModel

Name	Description	Type	Additional information
LocationID	Unique identifier of a Location	integer	None.
Company		CompanyModel	None.
IsActive	Indicates if location is currently active or not	boolean	None.
IsKeyAccount	Indicates if location is key account	boolean	None.
LocationCategory	Location category the location is associated with	LocationCategoryModel	None.
LocationName	Name of the location	string	None.
Address	Address of the location	string	None.
Address2	Second line of address of the location	string	None.
Address3		string	None.
City	City segment of the address	string	None.
State	State segment of the address	StateModel	None.
ZipCode	Zipcode segment of the address	string	None.
Country	Country segment of the address	CountryModel	None.
CityStateZipCountry	Combined City, State, Zip Code and Country line	string	None.
XCoordinate	Latitude coordinate of the location address	string	None.
YCoordinate	Longitude coordinate of the location address	string	None.
GooglePlaceID	Google Place ID	string	None.
GoogleURL	URL of location on Google Maps	string	None.
Term		TermModel	None.
BOLTemplate		BOLTemplateModel	None.
IsIntegrationControlled		boolean	None.
LocationRules		LocationRuleModel	None.

Response Formats

application/json, text/json

Sample:

{
  "locationID": 1,
  "company": {
    "companyID": 1,
    "companyName": "sample string 2",
    "companyCode": "sample string 3",
    "vatNumber": "sample string 4",
    "address1": "sample string 5",
    "address2": "sample string 6",
    "address3": "sample string 7",
    "address4": "sample string 8",
    "address5": "sample string 9",
    "email": "sample string 10",
    "currentRates": [
      {
        "companyRateID": 1,
        "rate": 2.0,
        "supportLevel": {
          "supportLevelID": 1,
          "supportLevel": "sample string 2"
        },
        "startDate": "2025-11-08T08:26:28.7623187+00:00"
      },
      {
        "companyRateID": 1,
        "rate": 2.0,
        "supportLevel": {
          "supportLevelID": 1,
          "supportLevel": "sample string 2"
        },
        "startDate": "2025-11-08T08:26:28.7623187+00:00"
      }
    ]
  },
  "isActive": true,
  "isKeyAccount": true,
  "locationCategory": {
    "locationCategoryID": 1,
    "locationCategory": "sample string 2",
    "isSystem": true
  },
  "locationName": "sample string 4",
  "address": "sample string 5",
  "address2": "sample string 6",
  "address3": "sample string 7",
  "city": "sample string 8",
  "state": {
    "stateID": 1,
    "stateShortName": "sample string 2",
    "stateLongName": "sample string 3"
  },
  "zipCode": "sample string 9",
  "country": {
    "countryID": 1,
    "countryShortName": "sample string 2",
    "countryLongName": "sample string 3"
  },
  "cityStateZipCountry": "sample string 10",
  "xCoordinate": "sample string 11",
  "yCoordinate": "sample string 12",
  "googlePlaceID": "sample string 13",
  "googleURL": "sample string 14",
  "term": {
    "termID": 1,
    "term": "sample string 2",
    "isActive": true
  },
  "bolTemplate": {
    "bolTemplateID": 1,
    "templateName": "sample string 2"
  },
  "isIntegrationControlled": true,
  "locationRules": {
    "locationRuleID": 1,
    "shipMethod": {
      "shipMethodID": 1,
      "shipMethod": "sample string 2"
    },
    "isLocked": true,
    "canSelfOrder": true,
    "additionalBillingDays": 4,
    "allowUDFAddress": true,
    "palletLabelQuantity": 6,
    "returnFlagType": {
      "flagTypeID": 1,
      "flagType": "sample string 2",
      "isActive": true,
      "isSystem": true,
      "isCleared": true,
      "isDefault": true,
      "isRepair": true,
      "isAdmin": true,
      "isRepairComponent": true
    },
    "returnFlagBarcodePrefix": "sample string 7"
  }
}