---
title: "Retrieve locations"
method: GET
path: "/odata/locations/Service.ForServiceRequest()"
tags: ["Locations"]
---

# Retrieve locations

`GET /odata/locations/Service.ForServiceRequest()`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/odata/locations/Service.ForServiceRequest()`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/odata/locations/Service.ForServiceRequest()/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of locations of a service request. You can use filter parameters to make the request more specific.

## Query parameters

- `$expand` string
- `$select` string
- `$filter` string
- `$orderby` string
- `$top` integer
- `$skip` integer
- `$count` boolean

## Response `200`

The requested locations are in the response.

- ServiceChannelServicesMessagingLocationLocation[]
  - `Id` integer: Unique location identifier.
  - `SubscriberId` integer: Unique subscriber identifier.
  - `SubscriberName` string
  - `StoreId` string: Alphanumeric identifier of the store in the client's system. Assigned by and unique per subscriber.
  - `Name` string: Location name.
  - `ShortName` string: Shortened location name.
  - `Latitude` number, double: Global position. Latitude.
  - `Longitude` number, double: Global position. Longitude.
  - `Distance` number, double: Distance from GPS coordinate to this location
  - `Radius` number, double: GPS radius for the location.
  - `LocationTypeId` integer: Numeric identifier of the location type.
  - `Address1` string: Additional location address.
  - `Address2` string: Main location address.
  - `City` string: Location city.
  - `State` string: State where the location is situated.
  - `StateId` integer: Numeric identifier of the location’s state.
  - `Region` string: Part of the country where the location is situated.
  - `District` string: Abbreviation of the town or country area where the location is situated.
  - `Zip` string: Location ZIP or postal code.
  - `Country` string: Abbreviation of the country name where the location is situated.
  - `CountryId` integer: Numeric identifier of the country of the location.
  - `ClosedDate` string, date-time: Last day when the location is open for business.
  - `OpenDate` string, date-time: First day when the location is open for business.
  - `Status` string: Status of the location. Possible values: *open*, *closed*.
  - `Email` string: Email the location can be contacted at.
  - `FaxNumber` string: Fax number the location can be contacted at.
  - `Phone` string: Contact phone number of the location.
  - `Contact` string: Name of the main person to contact at the location.
  - `HasInventory` boolean: Indicates whether it’s an inventory location or not. Possible values: *true*, *false*.
  - `SquareValue` number, double: Square value of the facility.
  - `SquareMeasure` string: Unit or system of units for measuring location area.
  - `TimeZoneInfoId` integer: Numeric identifier of the location time zone.
  - `TimeZoneShortDescription` string: Location time zone abbreviation.
  - `TimeZoneMsName` string: Location time zone Microsoft Name. e.g "Eastern Standard Time"
  - `TimeZoneIanaName` string: Location time zone Iana Name. e.g. "America/New_York"
  - `TypeLabel` string: [Inventory location type](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/1209106525/Creating+Inventory+Locations?preview=%2F1209106525%2F1205830388%2FSupply-House-Type.png). Possible values: *Location*, *Warehouse*, *Supply House*, *Truck*.
  - `Supplier` string: Supplier’s location name.
  - `CountyId` integer: County numeric identifier.
  - `Notes` ServiceChannelServicesMessagingLocationNoteLocationNote[]
    - `Id` integer: Location note numeric identifier.
    - `HeaderId` integer: Unique location note header identifier.
    - `Value` string: Location note content.
    - `Header` string: Name of the note.
  - `TimeShiftToEST` integer
  - `AddressTypeId` integer: Address format pattern Id
  - `FormattedAddress` string
  - `LocationFormattedAddressTail` string
  - `IsInternational` boolean
  - `Address` string

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)
