SEservicechannel
Locations

Get locations by geographic coordinates

Returns locations that are near the longitude and latitude specified in the request. Use the filter parameters to make the request more specific.

get/odata/locations/Service.NearBy(latitude={latitude},longitude={longitude})

Request

Path parameters

longitudenumber double required

Location’s global position. Longitude.

latitudenumber double required

Location’s global position. Latitude.

Query parameters

$expandstring

Expand a navigation property.

$selectstring

Select a set of properties to return.

$filterstring

Filter a collection of resources addressed by a request URL.

$orderbystring

Order resources by the specified property in the response.

$topinteger

Return the specified number of items in the response.

$skipinteger

Skip the specified number of items in the response.

$countboolean

Include the count of the matching resources in the response.

Response

The requested locations are in the response.

Idinteger

Unique location identifier.

SubscriberIdinteger

Unique subscriber identifier.

SubscriberNamestring
StoreIdstring

Alphanumeric identifier of the store in the client's system. Assigned by and unique per subscriber.

Namestring

Location name.

ShortNamestring

Shortened location name.

Latitudenumber double

Global position. Latitude.

Longitudenumber double

Global position. Longitude.

Distancenumber double

Distance from GPS coordinate to this location

Radiusnumber double

GPS radius for the location.

LocationTypeIdinteger

Numeric identifier of the location type.

Address1string

Additional location address.

Address2string

Main location address.

Citystring

Location city.

Statestring

State where the location is situated.

StateIdinteger

Numeric identifier of the location’s state.

Regionstring

Part of the country where the location is situated.

Districtstring

Abbreviation of the town or country area where the location is situated.

Zipstring

Location ZIP or postal code.

Countrystring

Abbreviation of the country name where the location is situated.

CountryIdinteger

Numeric identifier of the country of the location.

ClosedDatestring date-time

Last day when the location is open for business.

OpenDatestring date-time

First day when the location is open for business.

Statusstring

Status of the location. Possible values: open, closed.

Emailstring

Email the location can be contacted at.

FaxNumberstring

Fax number the location can be contacted at.

Phonestring

Contact phone number of the location.

Contactstring

Name of the main person to contact at the location.

HasInventoryboolean

Indicates whether it’s an inventory location or not. Possible values: true, false.

SquareValuenumber double

Square value of the facility.

SquareMeasurestring

Unit or system of units for measuring location area.

TimeZoneInfoIdinteger

Numeric identifier of the location time zone.

TimeZoneShortDescriptionstring

Location time zone abbreviation.

TimeZoneMsNamestring

Location time zone Microsoft Name. e.g "Eastern Standard Time"

TimeZoneIanaNamestring

Location time zone Iana Name. e.g. "America/New_York"

TypeLabelstring

Inventory location type. Possible values: Location, Warehouse, Supply House, Truck.

Supplierstring

Supplier’s location name.

CountyIdinteger

County numeric identifier.

TimeShiftToESTinteger
AddressTypeIdinteger

Address format pattern Id

FormattedAddressstring
LocationFormattedAddressTailstring
IsInternationalboolean
Addressstring

Changes

No recorded changes to this operation across all 1 revision of this API.