SEservicechannel
Locations

Get locations by filters

Returns locations based on the filters applied. By default closed locations are not included in the response. To include them, set the IncludeClosedLocations parameter to true.

post/GetFilteredLocations

Request

Request body

ProviderIdinteger

Unique provider identifier.

LocationIdsinteger[]

Unique location identifier.

Namestring

Location name.

Addressstring

Main location address.

CountryIdinteger

Numeric identifier of the location country.

StateIdsinteger[]

Numeric identifier of the location’s state.

Citystring

Location city.

Regionstring

Part of the country where the location is situated.

Districtstring

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

IncludeClosedLocationsboolean

Flag to include closed locations in the result.

Response

The filtered locations are in the response.

Idinteger

Unique location identifier.

StoreIdstring

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

Namestring

Location name.

Addressstring

Main location address.

Citystring

Location city.

Statestring

State where the location is situated.

Zipstring

Location ZIP or postal code.

Phonestring

Contact phone number of the location.

Regionstring

Part of the country where the location is situated.

Districtstring

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

StateIdinteger

Numeric identifier of the location’s state.

FullNamestring
AddressAddlstring
StoreOpenstring date-time
StoreClosestring date-time
Latitudenumber double
Longitudenumber double
CountyIdinteger
Countystring
Statusstring
SubscriberIdinteger
SubscriberNamestring

Changes

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