WebSphere Commerce Service - Location Based Services
These services provide APIs related to locational data, including the store locator feature. In a B2C store, shoppers use the the store locator feature to locate a nearby store, where a list of nearby stores is given based on the the location entered by the shopper. In a B2B store, the store locator displays countries that stores are located in. Schemes: https
Summary
Tag: Client Locations
This class provides RESTful services to retrieve data on client locations. It uses ClientLocation noun.
Tag: Client Location
This class provides RESTful services to create and retrieve client location data. It uses ClientLocation noun.
Operation Description POST /store/{storeId}/clientLocation Create location
PUT /store/{storeId}/clientLocation/{clientLocationId} Update location
GET /store/{storeId}/clientLocation/{clientLocationId} Get location by location ID
DELETE /store/{storeId}/clientLocation/{clientLocationId} Delete location
Tag: Store Locator
This class provides RESTful services to get store location details. It performs the service by delegating to the PhysicalStore and GeoNode BOD services.
Operation Description GET /store/{storeId}/storelocator/byLocation Get by specified location
GET /store/{storeId}/storelocator/byStoreId/{uniqueId} Get by store unique ID
GET /store/{storeId}/storelocator/byStoreIds Get by store unique IDs
GET /store/{storeId}/storelocator/latitude/{latitude}/longitude/{longitude} Get by specified coordinates
GET /store/{storeId}/storelocator/byGeoNode/{geoId} Get by geo node unique ID
Tag: Country
This class provides RESTful services to get countries or regions and states or provinces information.
Operation Description GET /store/{storeId}/country/country_state_list Get countries and regions
GET /store/{storeId}/country/country_state_name Get display name of countries and regions
Tag: Points of Interest
This class provides RESTful services to retrieve data on points of interest. It uses PointOfInterest noun.
Operation Description GET /store/{storeId}/pointsOfInterest/byXPath Get POI by XPath
GET /store/{storeId}/pointsOfInterest/byStatus/{status} Get POI by status
GET /store/{storeId}/pointsOfInterest/byZoneId/{zoneId} Get POI by zone ID
GET /store/{storeId}/pointsOfInterest/byTag/{tag} Get POI by tags
GET /store/{storeId}/pointsOfInterest/byCellId/{cellId} Get POI by cell ID
GET /store/{storeId}/pointsOfInterest/byPOIType/{poiType} Get POI by POI type
GET /store/{storeId}/pointsOfInterest Get all POI
GET /store/{storeId}/pointsOfInterest/byProximity Get POIs by proximity
GET /store/{storeId}/pointsOfInterest/byRegionId/{regionId} Get POI by region ID
Tag: Point of Interest
This class provides RESTful services to retrieve point of interest data. It uses PointOfInterest noun.
Operation Description GET /store/{storeId}/pointOfInterest/byProximity Get POI by proximity
POST /store/{storeId}/pointOfInterest Create POI
PUT /store/{storeId}/pointOfInterest/{pointOfInterestId} Update POI
GET /store/{storeId}/pointOfInterest/{pointOfInterestId} Get POI by POI ID
DELETE /store/{storeId}/pointOfInterest/{pointOfInterestId} Delete POI
Tag: Geonode
This class provides RESTful services to get geo node details. It performs the service by delegating to the GeoNode BOD service.
Operation Description GET /store/{storeId}/geonode/byParentGeoNode/{parentgeoid} Gets by parent unique ID
GET /store/{storeId}/geonode Get by query
GET /store/{storeId}/geonode/byTopGeoNode Gets by site top-nodes
Paths
Create locationPOST /store/{storeId}/clientLocation
Tags: Client LocationCreates a client location.
application/json application/xml
storeId path string responseFormat query string
Delete location application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
DELETE /store/{storeId}/clientLocation/{clientLocationId}
Tags: Client LocationDeletes a client location.
clientLocationId path string storeId path string responseFormat query string
Get location by location ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocation/{clientLocationId}
Tags: Client LocationGets a client location by client location ID.
clientLocationId path string storeId path string responseFormat query string
Update location application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
PUT /store/{storeId}/clientLocation/{clientLocationId}
Tags: Client LocationUpdates a client location.
application/json application/xml
clientLocationId path string storeId path string path query string operation query string responseFormat query string
Get all locations application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations
Tags: Client LocationsGets all client locations.
storeId path string responseFormat query string
Get location by action application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byAction/{action}
Tags: Client LocationsGets client locations by action.
action path string storeId path string responseFormat query string
Get location by cell ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byCellId/{cellId}
Tags: Client LocationsGets client locations by cell ID.
cellId path string storeId path string responseFormat query string
Get location by client ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byClientId/{clientId}
Tags: Client LocationsGets client locations by client ID.
clientId path string storeId path string responseFormat query string
Get location by client type application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byClientType/{clientType}
Tags: Client LocationsGets client locations by client type.
clientType path string storeId path string responseFormat query string
Get location by device ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byDeviceId/{deviceId}
Tags: Client LocationsGets client locations by device ID.
deviceId path string storeId path string responseFormat query string
Get location by personalization ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byPersonalizationId/{personalizationId}
Tags: Client LocationsGets client locations by personalization ID.
personalizationId path string storeId path string responseFormat query string
Get location by interest ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byPointOfInterestId/{pointOfInterestId}
Tags: Client LocationsGets client locations by point of interest ID.
pointOfInterestId path string storeId path string responseFormat query string
Get location by point of interest type application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byPOIType/{poiType}
Tags: Client LocationsGets client locations by point of interest type.
poiType path string storeId path string responseFormat query string
Get location by region ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byRegionId/{regionId}
Tags: Client LocationsGets client locations by region ID.
regionId path string storeId path string responseFormat query string
Get location by source ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/bySourceId/{sourceId}
Tags: Client LocationsGets client locations by source ID.
sourceId path string storeId path string responseFormat query string
Get location by source type application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/bySourceType/{sourceType}
Tags: Client LocationsGets client locations by source type.
sourceType path string storeId path string responseFormat query string
Get location by status application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byStatus/{status}
Tags: Client LocationsGets client location by status.
status path string storeId path string responseFormat query string
Get location by tag application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byTag/{tag}
Tags: Client LocationsGets client locations by tag.
tag path string storeId path string responseFormat query string
Get location by XPath application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byXPath
Tags: Client LocationsGets client locations by XPath.
storeId path string xPath query string responseFormat query string
Get location by zone ID application/atom+xml application/json application/xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/clientLocations/byZoneId/{zoneId}
Tags: Client LocationsGets client locations by zone ID.
zoneId path string storeId path string responseFormat query string
Get countries and regions application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/country/country_state_list
Tags: CountryGets a list of countries or regions with the corresponding states or provinces.
storeId The store identifier.
path string profileName Profile name. Profiles determine the subset of data returned by a query. Default profile name = IBM_countryStateList_Summary.
query string , x ∈ { IBM_countryStateList_Summary } countryCode The country or region abbreviation code.
query string
Get display name of countries and regions application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"countries": [
{
"callingCode": "+93",
"code": "AF",
"displayName": "Afghanistan",
"states": [
]
},
{
"callingCode": "+355",
"code": "AL",
"displayName": "Albania",
"states": [
]
},
{
"callingCode": "+213",
"code": "DZ",
"displayName": "Algeria",
"states": [
]
},
{
"callingCode": "+684",
"code": "AS",
"displayName": "American Samoa",
"states": [
]
},
{
"callingCode": "+376",
"code": "AD",
"displayName": "Andorra",
"states": [
]
},
{
"callingCode": "+244",
"code": "AO",
"displayName": "Angola",
"states": [
]
},
{
"callingCode": "+1-264",
"code": "AI",
"displayName": "Anguilla",
"states": [
]
},
{
"callingCode": "+672",
"code": "AQ",
"displayName": "Antarctica",
"states": [
]
},
{
"callingCode": "+1-268",
"code": "AG",
"displayName": "Antigua and Barbuda",
"states": [
]
},
{
"callingCode": "+54",
"code": "AR",
"displayName": "Argentina",
"states": [
]
},
{
"callingCode": "+374",
"code": "AM",
"displayName": "Armenia",
"states": [
]
},
{
"callingCode": "+297",
"code": "AW",
"displayName": "Aruba",
"states": [
]
},
{
"callingCode": "+61",
"code": "AU",
"displayName": "Australia",
"states": [
]
},
{
"callingCode": "+43",
"code": "AT",
"displayName": "Austria",
"states": [
]
},
{
"callingCode": "+994",
"code": "AZ",
"displayName": "Azerbaijan",
"states": [
]
},
{
"callingCode": "+1-242",
"code": "BS",
"displayName": "Bahamas",
"states": [
]
},
{
"callingCode": "+973",
"code": "BH",
"displayName": "Bahrain",
"states": [
]
},
{
"callingCode": "+880",
"code": "BD",
"displayName": "Bangladesh",
"states": [
]
},
{
"callingCode": "+1-246",
"code": "BB",
"displayName": "Barbados",
"states": [
]
},
{
"callingCode": "+375",
"code": "BY",
"displayName": "Belarus",
"states": [
]
},
{
"callingCode": "+32",
"code": "BE",
"displayName": "Belgium",
"states": [
]
},
{
"callingCode": "+501",
"code": "BZ",
"displayName": "Belize",
"states": [
]
},
{
"callingCode": "+229",
"code": "BJ",
"displayName": "Benin",
"states": [
]
},
{
"callingCode": "+1-441",
"code": "BM",
"displayName": "Bermuda",
"states": [
]
},
{
"callingCode": "+975",
"code": "BT",
"displayName": "Bhutan",
"states": [
]
},
{
"callingCode": "+591",
"code": "BO",
"displayName": "Bolivia",
"states": [
]
},
{
"callingCode": "+387",
"code": "BA",
"displayName": "Bosnia and Herzegovina",
"states": [
]
},
{
"callingCode": "+267",
"code": "BW",
"displayName": "Botswana",
"states": [
]
},
{
"callingCode": "",
"code": "BV",
"displayName": "Bouvet Island",
"states": [
]
},
{
"callingCode": "+55",
"code": "BR",
"displayName": "Brazil",
"states": [
]
},
{
"callingCode": "+246",
"code": "IO",
"displayName": "British Indian Ocean Territory",
"states": [
]
},
{
"callingCode": "+673",
"code": "BN",
"displayName": "Brunei",
"states": [
]
},
{
"callingCode": "+359",
"code": "BG",
"displayName": "Bulgaria",
"states": [
]
},
{
"callingCode": "+226",
"code": "BF",
"displayName": "Burkina Faso",
"states": [
]
},
{
"callingCode": "+257",
"code": "BI",
"displayName": "Burundi",
"states": [
]
},
{
"callingCode": "+855",
"code": "KH",
"displayName": "Cambodia",
"states": [
]
},
{
"callingCode": "+237",
"code": "CM",
"displayName": "Cameroon",
"states": [
]
},
{
"callingCode": "+1",
"code": "CA",
"displayName": "Canada",
"states": [
{
"code": "AB",
"displayName": "Alberta"
},
{
"code": "BC",
"displayName": "British Columbia"
},
{
"code": "MB",
"displayName": "Manitoba"
},
{
"code": "NB",
"displayName": "New Brunswick"
},
{
"code": "NL",
"displayName": "Newfoundland"
},
{
"code": "NT",
"displayName": "Northwest Territory"
},
{
"code": "NS",
"displayName": "Nova Scotia"
},
{
"code": "NU",
"displayName": "Nunavut"
},
{
"code": "ON",
"displayName": "Ontario"
},
{
"code": "PE",
"displayName": "Prince Edward Island"
},
{
"code": "QC",
"displayName": "Quebec"
},
{
"code": "SK",
"displayName": "Saskatchewan"
},
{
"code": "YT",
"displayName": "Yukon"
}
]
},
{
"callingCode": "+238",
"code": "CV",
"displayName": "Cape Verde",
"states": [
]
},
{
"callingCode": "+1-345",
"code": "KY",
"displayName": "Cayman Islands",
"states": [
]
},
{
"callingCode": "+236",
"code": "CF",
"displayName": "Central African Republic",
"states": [
]
},
{
"callingCode": "+235",
"code": "TD",
"displayName": "Chad",
"states": [
]
},
{
"callingCode": "+56",
"code": "CL",
"displayName": "Chile",
"states": [
]
},
{
"callingCode": "+86",
"code": "CN",
"displayName": "China",
"states": [
]
},
{
"callingCode": "+61-8",
"code": "CX",
"displayName": "Christmas Island",
"states": [
]
},
{
"callingCode": "+61",
"code": "CC",
"displayName": "Cocos Islands",
"states": [
]
},
{
"callingCode": "+57",
"code": "CO",
"displayName": "Colombia",
"states": [
]
},
{
"callingCode": "+269",
"code": "KM",
"displayName": "Comoros",
"states": [
]
},
{
"callingCode": "+242",
"code": "CG",
"displayName": "Congo",
"states": [
]
},
{
"callingCode": "+243",
"code": "CD",
"displayName": "Congo, Democratic Republic of the",
"states": [
]
},
{
"callingCode": "+682",
"code": "CK",
"displayName": "Cook Islands",
"states": [
]
},
{
"callingCode": "+506",
"code": "CR",
"displayName": "Costa Rica",
"states": [
]
},
{
"callingCode": "+225",
"code": "CI",
"displayName": "Cote d'Ivoire",
"states": [
]
},
{
"callingCode": "+385",
"code": "HR",
"displayName": "Croatia",
"states": [
]
},
{
"callingCode": "+53",
"code": "CU",
"displayName": "Cuba",
"states": [
]
},
{
"callingCode": "+357",
"code": "CY",
"displayName": "Cyprus",
"states": [
]
},
{
"callingCode": "+420",
"code": "CZ",
"displayName": "Czech Republic",
"states": [
]
},
{
"callingCode": "+45",
"code": "DK",
"displayName": "Denmark",
"states": [
]
},
{
"callingCode": "+253",
"code": "DJ",
"displayName": "Djibouti",
"states": [
]
},
{
"callingCode": "+1-767",
"code": "DM",
"displayName": "Dominica",
"states": [
]
},
{
"callingCode": "+1-809",
"code": "DO",
"displayName": "Dominican Republic",
"states": [
]
},
{
"callingCode": "+670",
"code": "TP",
"displayName": "East Timor",
"states": [
]
},
{
"callingCode": "+593",
"code": "EC",
"displayName": "Ecuador",
"states": [
]
},
{
"callingCode": "+20",
"code": "EG",
"displayName": "Egypt",
"states": [
]
},
{
"callingCode": "+503",
"code": "SV",
"displayName": "El Salvador",
"states": [
]
},
{
"callingCode": "+240",
"code": "GQ",
"displayName": "Equatorial Guinea",
"states": [
]
},
{
"callingCode": "+291",
"code": "ER",
"displayName": "Eritrea",
"states": [
]
},
{
"callingCode": "+372",
"code": "EE",
"displayName": "Estonia",
"states": [
]
},
{
"callingCode": "+251",
"code": "ET",
"displayName": "Ethiopia",
"states": [
]
},
{
"callingCode": "+500",
"code": "FK",
"displayName": "Falkland Islands",
"states": [
]
},
{
"callingCode": "+298",
"code": "FO",
"displayName": "Faroe Islands",
"states": [
]
},
{
"callingCode": "+679",
"code": "FJ",
"displayName": "Fiji",
"states": [
]
},
{
"callingCode": "+358",
"code": "FI",
"displayName": "Finland",
"states": [
]
},
{
"callingCode": "+33",
"code": "FR",
"displayName": "France",
"states": [
]
},
{
"callingCode": "+594",
"code": "GF",
"displayName": "French Guiana",
"states": [
]
},
{
"callingCode": "+689",
"code": "PF",
"displayName": "French Polynesia",
"states": [
]
},
{
"callingCode": "",
"code": "TF",
"displayName": "French Southern Territories",
"states": [
]
},
{
"callingCode": "+241",
"code": "GA",
"displayName": "Gabon",
"states": [
]
},
{
"callingCode": "+220",
"code": "GM",
"displayName": "Gambia",
"states": [
]
},
{
"callingCode": "+995",
"code": "GE",
"displayName": "Georgia",
"states": [
]
},
{
"callingCode": "+49",
"code": "DE",
"displayName": "Germany",
"states": [
]
},
{
"callingCode": "+233",
"code": "GH",
"displayName": "Ghana",
"states": [
]
},
{
"callingCode": "+350",
"code": "GI",
"displayName": "Gibraltar",
"states": [
]
},
{
"callingCode": "+30",
"code": "GR",
"displayName": "Greece",
"states": [
]
},
{
"callingCode": "+299",
"code": "GL",
"displayName": "Greenland",
"states": [
]
},
{
"callingCode": "+1-473",
"code": "GD",
"displayName": "Grenada",
"states": [
]
},
{
"callingCode": "+590",
"code": "GP",
"displayName": "Guadeloupe",
"states": [
]
},
{
"callingCode": "+1-671",
"code": "GU",
"displayName": "Guam",
"states": [
]
},
{
"callingCode": "+502",
"code": "GT",
"displayName": "Guatemala",
"states": [
]
},
{
"callingCode": "+224",
"code": "GN",
"displayName": "Guinea",
"states": [
]
},
{
"callingCode": "+245",
"code": "GW",
"displayName": "Guinea-Bissau",
"states": [
]
},
{
"callingCode": "+592",
"code": "GY",
"displayName": "Guyana",
"states": [
]
},
{
"callingCode": "+509",
"code": "HT",
"displayName": "Haiti",
"states": [
]
},
{
"callingCode": "",
"code": "HM",
"displayName": "Heard Island and Mcdonald Islands",
"states": [
]
},
{
"callingCode": "+379",
"code": "VA",
"displayName": "Holy See",
"states": [
]
},
{
"callingCode": "+504",
"code": "HN",
"displayName": "Honduras",
"states": [
]
},
{
"callingCode": "+852",
"code": "HK",
"displayName": "Hong Kong S.A.R. of China",
"states": [
]
},
{
"callingCode": "+36",
"code": "HU",
"displayName": "Hungary",
"states": [
]
},
{
"callingCode": "+354",
"code": "IS",
"displayName": "Iceland",
"states": [
]
},
{
"callingCode": "+91",
"code": "IN",
"displayName": "India",
"states": [
]
},
{
"callingCode": "+62",
"code": "ID",
"displayName": "Indonesia",
"states": [
]
},
{
"callingCode": "+98",
"code": "IR",
"displayName": "Iran",
"states": [
]
},
{
"callingCode": "+964",
"code": "IQ",
"displayName": "Iraq",
"states": [
]
},
{
"callingCode": "+353",
"code": "IE",
"displayName": "Ireland",
"states": [
]
},
{
"callingCode": "+972",
"code": "IL",
"displayName": "Israel",
"states": [
]
},
{
"callingCode": "+39",
"code": "IT",
"displayName": "Italy",
"states": [
]
},
{
"callingCode": "+1-876",
"code": "JM",
"displayName": "Jamaica",
"states": [
]
},
{
"callingCode": "+81",
"code": "JP",
"displayName": "Japan",
"states": [
{
"code": "Aichi",
"displayName": "Aichi"
},
{
"code": "Akita",
"displayName": "Akita"
},
{
"code": "Aomori",
"displayName": "Aomori"
},
{
"code": "Chiba",
"displayName": "Chiba"
},
{
"code": "Ehime",
"displayName": "Ehime"
},
{
"code": "Fukui",
"displayName": "Fukui"
},
{
"code": "Fukuoka",
"displayName": "Fukuoka"
},
{
"code": "Fukushima",
"displayName": "Fukushima"
},
{
"code": "Gifu",
"displayName": "Gifu"
},
{
"code": "Gunma",
"displayName": "Gunma"
},
{
"code": "Hiroshima",
"displayName": "Hiroshima"
},
{
"code": "Hokkaido",
"displayName": "Hokkaido"
},
{
"code": "Hyogo",
"displayName": "Hyogo"
},
{
"code": "Ibaraki",
"displayName": "Ibaraki"
},
{
"code": "Ishikawa",
"displayName": "Ishikawa"
},
{
"code": "Iwate",
"displayName": "Iwate"
},
{
"code": "Kagawa",
"displayName": "Kagawa"
},
{
"code": "Kagoshima",
"displayName": "Kagoshima"
},
{
"code": "Kanagawa",
"displayName": "Kanagawa"
},
{
"code": "Kochi",
"displayName": "Kochi"
},
{
"code": "Kumamoto",
"displayName": "Kumamoto"
},
{
"code": "Kyoto",
"displayName": "Kyoto"
},
{
"code": "Mie",
"displayName": "Mie"
},
{
"code": "Miyagi",
"displayName": "Miyagi"
},
{
"code": "Miyazaki",
"displayName": "Miyazaki"
},
{
"code": "Nagano",
"displayName": "Nagano"
},
{
"code": "Nagasaki",
"displayName": "Nagasaki"
},
{
"code": "Nara",
"displayName": "Nara"
},
{
"code": "Niigata",
"displayName": "Niigata"
},
{
"code": "Oita",
"displayName": "Oita"
},
{
"code": "Okayama",
"displayName": "Okayama"
},
{
"code": "Okinawa",
"displayName": "Okinawa"
},
{
"code": "Osaka",
"displayName": "Osaka"
},
{
"code": "Saga",
"displayName": "Saga"
},
{
"code": "Saitama",
"displayName": "Saitama"
},
{
"code": "Shiga",
"displayName": "Shiga"
},
{
"code": "Shimane",
"displayName": "Shimane"
},
{
"code": "Shizuoka",
"displayName": "Shizuoka"
},
{
"code": "Tochigi",
"displayName": "Tochigi"
},
{
"code": "Tokushima",
"displayName": "Tokushima"
},
{
"code": "Tokyo",
"displayName": "Tokyo"
},
{
"code": "Tottori",
"displayName": "Tottori"
},
{
"code": "Toyama",
"displayName": "Toyama"
},
{
"code": "Wakayama",
"displayName": "Wakayama"
},
{
"code": "Yamagata",
"displayName": "Yamagata"
},
{
"code": "Yamaguchi",
"displayName": "Yamaguchi"
},
{
"code": "Yamanashi",
"displayName": "Yamanashi"
}
]
},
{
"callingCode": "+962",
"code": "JO",
"displayName": "Jordan",
"states": [
]
},
{
"callingCode": "+7-6",
"code": "KZ",
"displayName": "Kazakhstan",
"states": [
]
},
{
"callingCode": "+254",
"code": "KE",
"displayName": "Kenya",
"states": [
]
},
{
"callingCode": "+686",
"code": "KI",
"displayName": "Kiribati",
"states": [
]
},
{
"callingCode": "+850",
"code": "KP",
"displayName": "Korea, North",
"states": [
]
},
{
"callingCode": "+82",
"code": "KR",
"displayName": "Korea, South",
"states": [
]
},
{
"callingCode": "+965",
"code": "KW",
"displayName": "Kuwait",
"states": [
]
},
{
"callingCode": "+996",
"code": "KG",
"displayName": "Kyrgyzstan",
"states": [
]
},
{
"callingCode": "+856",
"code": "LA",
"displayName": "Laos",
"states": [
]
},
{
"callingCode": "+371",
"code": "LV",
"displayName": "Latvia",
"states": [
]
},
{
"callingCode": "+961",
"code": "LB",
"displayName": "Lebanon",
"states": [
]
},
{
"callingCode": "+266",
"code": "LS",
"displayName": "Lesotho",
"states": [
]
},
{
"callingCode": "+231",
"code": "LR",
"displayName": "Liberia",
"states": [
]
},
{
"callingCode": "+218",
"code": "LY",
"displayName": "Libya",
"states": [
]
},
{
"callingCode": "+423",
"code": "LI",
"displayName": "Liechtenstein",
"states": [
]
},
{
"callingCode": "+370",
"code": "LT",
"displayName": "Lithuania",
"states": [
]
},
{
"callingCode": "+352",
"code": "LU",
"displayName": "Luxembourg",
"states": [
]
},
{
"callingCode": "+853",
"code": "MO",
"displayName": "Macau S.A.R. of China",
"states": [
]
},
{
"callingCode": "+389",
"code": "MK",
"displayName": "Macedonia",
"states": [
]
},
{
"callingCode": "+261",
"code": "MG",
"displayName": "Madagascar",
"states": [
]
},
{
"callingCode": "+265",
"code": "MW",
"displayName": "Malawi",
"states": [
]
},
{
"callingCode": "+60",
"code": "MY",
"displayName": "Malaysia",
"states": [
]
},
{
"callingCode": "+960",
"code": "MV",
"displayName": "Maldives",
"states": [
]
},
{
"callingCode": "+223",
"code": "ML",
"displayName": "Mali",
"states": [
]
},
{
"callingCode": "+356",
"code": "MT",
"displayName": "Malta",
"states": [
]
},
{
"callingCode": "+692",
"code": "MH",
"displayName": "Marshall Islands",
"states": [
]
},
{
"callingCode": "+596",
"code": "MQ",
"displayName": "Martinique",
"states": [
]
},
{
"callingCode": "+222",
"code": "MR",
"displayName": "Mauritania",
"states": [
]
},
{
"callingCode": "+230",
"code": "MU",
"displayName": "Mauritius",
"states": [
]
},
{
"callingCode": "+262",
"code": "YT",
"displayName": "Mayotte",
"states": [
]
},
{
"callingCode": "+52",
"code": "MX",
"displayName": "Mexico",
"states": [
]
},
{
"callingCode": "+691",
"code": "FM",
"displayName": "Micronesia",
"states": [
]
},
{
"callingCode": "+373",
"code": "MD",
"displayName": "Moldova",
"states": [
]
},
{
"callingCode": "+377",
"code": "MC",
"displayName": "Monaco",
"states": [
]
},
{
"callingCode": "+976",
"code": "MN",
"displayName": "Mongolia",
"states": [
]
},
{
"callingCode": "+1-664",
"code": "MS",
"displayName": "Montserrat",
"states": [
]
},
{
"callingCode": "+212",
"code": "MA",
"displayName": "Morocco",
"states": [
]
},
{
"callingCode": "+258",
"code": "MZ",
"displayName": "Mozambique",
"states": [
]
},
{
"callingCode": "+95",
"code": "MM",
"displayName": "Myanmar",
"states": [
]
},
{
"callingCode": "+264",
"code": "NA",
"displayName": "Namibia",
"states": [
]
},
{
"callingCode": "+674",
"code": "NR",
"displayName": "Nauru",
"states": [
]
},
{
"callingCode": "+977",
"code": "NP",
"displayName": "Nepal",
"states": [
]
},
{
"callingCode": "+31",
"code": "NL",
"displayName": "Netherlands",
"states": [
]
},
{
"callingCode": "+599",
"code": "AN",
"displayName": "Netherlands Antilles",
"states": [
]
},
{
"callingCode": "+687",
"code": "NC",
"displayName": "New Caledonia",
"states": [
]
},
{
"callingCode": "+64",
"code": "NZ",
"displayName": "New Zealand",
"states": [
]
},
{
"callingCode": "+505",
"code": "NI",
"displayName": "Nicaragua",
"states": [
]
},
{
"callingCode": "+227",
"code": "NE",
"displayName": "Niger",
"states": [
]
},
{
"callingCode": "+234",
"code": "NG",
"displayName": "Nigeria",
"states": [
]
},
{
"callingCode": "+683",
"code": "NU",
"displayName": "Niue",
"states": [
]
},
{
"callingCode": "+672",
"code": "NF",
"displayName": "Norfolk Island",
"states": [
]
},
{
"callingCode": "+1-670",
"code": "MP",
"displayName": "Northern Mariana Islands",
"states": [
]
},
{
"callingCode": "+47",
"code": "NO",
"displayName": "Norway",
"states": [
]
},
{
"callingCode": "+968",
"code": "OM",
"displayName": "Oman",
"states": [
]
},
{
"callingCode": "+92",
"code": "PK",
"displayName": "Pakistan",
"states": [
]
},
{
"callingCode": "+680",
"code": "PW",
"displayName": "Palau",
"states": [
]
},
{
"callingCode": "+970",
"code": "PS",
"displayName": "Palestinian Territory",
"states": [
]
},
{
"callingCode": "+507",
"code": "PA",
"displayName": "Panama",
"states": [
]
},
{
"callingCode": "+675",
"code": "PG",
"displayName": "Papua New Guinea",
"states": [
]
},
{
"callingCode": "+595",
"code": "PY",
"displayName": "Paraguay",
"states": [
]
},
{
"callingCode": "+51",
"code": "PE",
"displayName": "Peru",
"states": [
]
},
{
"callingCode": "+63",
"code": "PH",
"displayName": "Philippines",
"states": [
]
},
{
"callingCode": "+872",
"code": "PN",
"displayName": "Pitcairn",
"states": [
]
},
{
"callingCode": "+48",
"code": "PL",
"displayName": "Poland",
"states": [
]
},
{
"callingCode": "+351",
"code": "PT",
"displayName": "Portugal",
"states": [
]
},
{
"callingCode": "+1-778",
"code": "PR",
"displayName": "Puerto Rico",
"states": [
{
"code": "PR",
"displayName": "Puerto Rico"
}
]
},
{
"callingCode": "+974",
"code": "QA",
"displayName": "Qatar",
"states": [
]
},
{
"callingCode": "+262",
"code": "RE",
"displayName": "Reunion",
"states": [
]
},
{
"callingCode": "+40",
"code": "RO",
"displayName": "Romania",
"states": [
]
},
{
"callingCode": "+7",
"code": "RU",
"displayName": "Russian Federation",
"states": [
]
},
{
"callingCode": "+250",
"code": "RW",
"displayName": "Rwanda",
"states": [
]
},
{
"callingCode": "+290",
"code": "SH",
"displayName": "Saint Helena",
"states": [
]
},
{
"callingCode": "+1-869",
"code": "KN",
"displayName": "Saint Kitts and Nevis",
"states": [
]
},
{
"callingCode": "+1-758",
"code": "LC",
"displayName": "Saint Lucia",
"states": [
]
},
{
"callingCode": "+508",
"code": "PM",
"displayName": "Saint Pierre and Miquelon",
"states": [
]
},
{
"callingCode": "+1-784",
"code": "VC",
"displayName": "Saint Vincent and the Grenadines",
"states": [
]
},
{
"callingCode": "+685",
"code": "WS",
"displayName": "Samoa",
"states": [
]
},
{
"callingCode": "+378",
"code": "SM",
"displayName": "San Marino",
"states": [
]
},
{
"callingCode": "+239",
"code": "ST",
"displayName": "Sao Tome and Principe",
"states": [
]
},
{
"callingCode": "+966",
"code": "SA",
"displayName": "Saudi Arabia",
"states": [
]
},
{
"callingCode": "+221",
"code": "SN",
"displayName": "Senegal",
"states": [
]
},
{
"callingCode": "+248",
"code": "SC",
"displayName": "Seychelles",
"states": [
]
},
{
"callingCode": "+232",
"code": "SL",
"displayName": "Sierra Leone",
"states": [
]
},
{
"callingCode": "+65",
"code": "SG",
"displayName": "Singapore",
"states": [
]
},
{
"callingCode": "+421",
"code": "SK",
"displayName": "Slovakia",
"states": [
]
},
{
"callingCode": "+386",
"code": "SI",
"displayName": "Slovenia",
"states": [
]
},
{
"callingCode": "+677",
"code": "SB",
"displayName": "Solomon Islands",
"states": [
]
},
{
"callingCode": "+252",
"code": "SO",
"displayName": "Somalia",
"states": [
]
},
{
"callingCode": "+27",
"code": "ZA",
"displayName": "South Africa",
"states": [
]
},
{
"callingCode": "",
"code": "GS",
"displayName": "South Georgia and the South Sandwich Islands",
"states": [
]
},
{
"callingCode": "+34",
"code": "ES",
"displayName": "Spain",
"states": [
]
},
{
"callingCode": "+94",
"code": "LK",
"displayName": "Sri Lanka",
"states": [
]
},
{
"callingCode": "+249",
"code": "SD",
"displayName": "Sudan",
"states": [
]
},
{
"callingCode": "+597",
"code": "SR",
"displayName": "Suriname",
"states": [
]
},
{
"callingCode": "+79",
"code": "SJ",
"displayName": "Svalbard and Jan Mayen",
"states": [
]
},
{
"callingCode": "+268",
"code": "SZ",
"displayName": "Swaziland",
"states": [
]
},
{
"callingCode": "+46",
"code": "SE",
"displayName": "Sweden",
"states": [
]
},
{
"callingCode": "+41",
"code": "CH",
"displayName": "Switzerland",
"states": [
]
},
{
"callingCode": "+963",
"code": "SY",
"displayName": "Syria",
"states": [
]
},
{
"callingCode": "+886",
"code": "TW",
"displayName": "Taiwan",
"states": [
]
},
{
"callingCode": "+992",
"code": "TJ",
"displayName": "Tajikistan",
"states": [
]
},
{
"callingCode": "+255",
"code": "TZ",
"displayName": "Tanzania",
"states": [
]
},
{
"callingCode": "+66",
"code": "TH",
"displayName": "Thailand",
"states": [
]
},
{
"callingCode": "+228",
"code": "TG",
"displayName": "Togo",
"states": [
]
},
{
"callingCode": "+690",
"code": "TK",
"displayName": "Tokelau",
"states": [
]
},
{
"callingCode": "+676",
"code": "TO",
"displayName": "Tonga",
"states": [
]
},
{
"callingCode": "+1-868",
"code": "TT",
"displayName": "Trinidad and Tobago",
"states": [
]
},
{
"callingCode": "+216",
"code": "TN",
"displayName": "Tunisia",
"states": [
]
},
{
"callingCode": "+90",
"code": "TR",
"displayName": "Turkey",
"states": [
]
},
{
"callingCode": "+993",
"code": "TM",
"displayName": "Turkmenistan",
"states": [
]
},
{
"callingCode": "+1-649",
"code": "TC",
"displayName": "Turks and Caicos Islands",
"states": [
]
},
{
"callingCode": "+688",
"code": "TV",
"displayName": "Tuvalu",
"states": [
]
},
{
"callingCode": "+256",
"code": "UG",
"displayName": "Uganda",
"states": [
]
},
{
"callingCode": "+380",
"code": "UA",
"displayName": "Ukraine",
"states": [
]
},
{
"callingCode": "+971",
"code": "AE",
"displayName": "United Arab Emirates",
"states": [
]
},
{
"callingCode": "+44",
"code": "GB",
"displayName": "United Kingdom",
"states": [
]
},
{
"callingCode": "+1",
"code": "US",
"displayName": "United States",
"states": [
{
"code": "AL",
"displayName": "Alabama"
},
{
"code": "AK",
"displayName": "Alaska"
},
{
"code": "AS",
"displayName": "American Samoa"
},
{
"code": "AZ",
"displayName": "Arizona"
},
{
"code": "AR",
"displayName": "Arkansas"
},
{
"code": "AA",
"displayName": "Armed Forces Americas"
},
{
"code": "AE",
"displayName": "Armed Forces Europe"
},
{
"code": "AP",
"displayName": "Armed Forces Pacific"
},
{
"code": "CA",
"displayName": "California"
},
{
"code": "CO",
"displayName": "Colorado"
},
{
"code": "CT",
"displayName": "Connecticut"
},
{
"code": "DE",
"displayName": "Delaware"
},
{
"code": "DC",
"displayName": "District of Columbia"
},
{
"code": "FL",
"displayName": "Florida"
},
{
"code": "GA",
"displayName": "Georgia"
},
{
"code": "GU",
"displayName": "Guam"
},
{
"code": "HI",
"displayName": "Hawaii"
},
{
"code": "ID",
"displayName": "Idaho"
},
{
"code": "IL",
"displayName": "Illinois"
},
{
"code": "IN",
"displayName": "Indiana"
},
{
"code": "IA",
"displayName": "Iowa"
},
{
"code": "KS",
"displayName": "Kansas"
},
{
"code": "KY",
"displayName": "Kentucky"
},
{
"code": "LA",
"displayName": "Louisiana"
},
{
"code": "ME",
"displayName": "Maine"
},
{
"code": "MD",
"displayName": "Maryland"
},
{
"code": "MA",
"displayName": "Massachusetts"
},
{
"code": "MI",
"displayName": "Michigan"
},
{
"code": "MN",
"displayName": "Minnesota"
},
{
"code": "MS",
"displayName": "Mississippi"
},
{
"code": "MO",
"displayName": "Missouri"
},
{
"code": "MT",
"displayName": "Montana"
},
{
"code": "NE",
"displayName": "Nebraska"
},
{
"code": "NV",
"displayName": "Nevada"
},
{
"code": "NH",
"displayName": "New Hampshire"
},
{
"code": "NJ",
"displayName": "New Jersey"
},
{
"code": "NM",
"displayName": "New Mexico"
},
{
"code": "NY",
"displayName": "New York"
},
{
"code": "NC",
"displayName": "North Carolina"
},
{
"code": "ND",
"displayName": "North Dakota"
},
{
"code": "MP",
"displayName": "Northern Mariana Islands"
},
{
"code": "OH",
"displayName": "Ohio"
},
{
"code": "OK",
"displayName": "Oklahoma"
},
{
"code": "OR",
"displayName": "Oregon"
},
{
"code": "PW",
"displayName": "Palau"
},
{
"code": "PA",
"displayName": "Pennsylvania"
},
{
"code": "RI",
"displayName": "Rhode Island"
},
{
"code": "SC",
"displayName": "South Carolina"
},
{
"code": "SD",
"displayName": "South Dakota"
},
{
"code": "TN",
"displayName": "Tennessee"
},
{
"code": "TX",
"displayName": "Texas"
},
{
"code": "VI",
"displayName": "U.S. Virgin Islands"
},
{
"code": "UT",
"displayName": "Utah"
},
{
"code": "VT",
"displayName": "Vermont"
},
{
"code": "VA",
"displayName": "Virginia"
},
{
"code": "WA",
"displayName": "Washington"
},
{
"code": "WV",
"displayName": "West Virginia"
},
{
"code": "WI",
"displayName": "Wisconsin"
},
{
"code": "WY",
"displayName": "Wyoming"
}
]
},
{
"callingCode": "+808",
"code": "UM",
"displayName": "United States Minor Outlying Islands",
"states": [
]
},
{
"callingCode": "+598",
"code": "UY",
"displayName": "Uruguay",
"states": [
]
},
{
"callingCode": "+998",
"code": "UZ",
"displayName": "Uzbekistan",
"states": [
]
},
{
"callingCode": "+678",
"code": "VU",
"displayName": "Vanuatu",
"states": [
]
},
{
"callingCode": "+58",
"code": "VE",
"displayName": "Venezuela",
"states": [
]
},
{
"callingCode": "+84",
"code": "VN",
"displayName": "Viet Nam",
"states": [
]
},
{
"callingCode": "+1-284",
"code": "VG",
"displayName": "Virgin Islands, British",
"states": [
]
},
{
"callingCode": "+1-340",
"code": "VI",
"displayName": "Virgin Islands, US",
"states": [
]
},
{
"callingCode": "+681",
"code": "WF",
"displayName": "Wallis and Futuna",
"states": [
]
},
{
"callingCode": "+212",
"code": "EH",
"displayName": "Western Saraha",
"states": [
]
},
{
"callingCode": "+967",
"code": "YE",
"displayName": "Yemen",
"states": [
]
},
{
"callingCode": "+381",
"code": "YU",
"displayName": "Yugoslavia",
"states": [
]
},
{
"callingCode": "+260",
"code": "ZM",
"displayName": "Zambia",
"states": [
]
},
{
"callingCode": "+263",
"code": "ZW",
"displayName": "Zimbabwe",
"states": [
]
}
],
"countryCodeStates": null
}com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/country/country_state_name
Tags: CountryGets the display name of a country and/or a state.
storeId The store identifier.
path string profileName Profile name. Profiles determine the subset of data returned by a query. The default profile name is IBM_countryStateName.
query string , x ∈ { IBM_countryStateName } countryCode The country or region abbreviation code.
query string stateCode The state or province abbreviation code.
query string
Get by query application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"countryDisplayName": "Canada",
"stateDisplayName": "Ontario"
}com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateName
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/geonode
Tags: GeonodeFinds geo nodes based on query name. See each query for details on input and output.
storeId The store identifier.
path string q The query name.
query string , x ∈ { byGeoNodeTypeAndName }
Gets by parent unique ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/geonode/byParentGeoNode/{parentgeoid}
Tags: GeonodeGets the geo nodes by the parent geo node unique ID. The response schema will flatten the result if a single object is returned in the list.
storeId The store identifier.
path string parentgeoid The parent geo node identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Gets by site top-nodes application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"GeoNode": [
{
"Description": [
{
"shortDescription": "Calgary"
}
],
"name": "Calgary",
"type": "CITY",
"uniqueID": "10004"
},
{
"Description": [
{
"shortDescription": "Edmonton"
}
],
"name": "Edmonton",
"type": "CITY",
"uniqueID": "10005"
},
{
"Description": [
{
"shortDescription": "Lethbridge"
}
],
"name": "Lethbridge",
"type": "CITY",
"uniqueID": "10006"
},
{
"Description": [
{
"shortDescription": "Medicine Hat"
}
],
"name": "Medicine Hat",
"type": "CITY",
"uniqueID": "10007"
},
{
"Description": [
{
"shortDescription": "Red Deer"
}
],
"name": "Red Deer",
"type": "CITY",
"uniqueID": "10008"
},
{
"Description": [
{
"shortDescription": "St. Albert"
}
],
"name": "St. Albert",
"type": "CITY",
"uniqueID": "10009"
},
{
"Description": [
{
"shortDescription": "Strathcona County"
}
],
"name": "Strathcona County",
"type": "CITY",
"uniqueID": "10010"
}
],
"recordSetComplete": "true",
"recordSetCount": "7",
"recordSetStartNumber": "0",
"recordSetTotal": "7",
"resourceId": "http://localhost:80/wcs/resources/store/10001/geonode/byParentGeoNode/10003?responseFormat=json",
"resourceName": "geonode"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/geonode/byTopGeoNode
Tags: GeonodeGets the top geo nodes for the site. The response schema will flatten the result if a single object is returned in the list.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Create POI application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"GeoNode": [
{
"Description": [
{
"shortDescription": "Canada"
}
],
"name": "Canada",
"type": "CNTY",
"uniqueID": "10001"
},
{
"Description": [
{
"shortDescription": "United States"
}
],
"name": "United States",
"type": "CNTY",
"uniqueID": "10002"
}
],
"recordSetComplete": "true",
"recordSetCount": "2",
"recordSetStartNumber": "0",
"recordSetTotal": "2",
"resourceId": "http://localhost:80/wcs/resources/store/10001/geonode/byTopGeoNode?siteLevelSearch=false&responseFormat=json",
"resourceName": "geonode"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/pointOfInterest
Tags: Point of InterestCreates a point of interest.
application/json application/xml
storeId path string responseFormat query string
Get POI by proximity application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointOfInterest/byProximity
Tags: Point of Interest"Gets the point of interest by proximity based on specified geolocation, POI type, and radius."
storeId path string langId query string latitude query string longitude query string poiType query string responseFormat query string
Delete POI application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
DELETE /store/{storeId}/pointOfInterest/{pointOfInterestId}
Tags: Point of InterestDeletes a point of interest.
pointOfInterestId path string storeId path string responseFormat query string
Get POI by POI ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointOfInterest/{pointOfInterestId}
Tags: Point of InterestGets the point of interest by the point of interest ID.
storeId path string pointOfInterestId path string langId query string responseFormat query string
Update POI application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
PUT /store/{storeId}/pointOfInterest/{pointOfInterestId}
Tags: Point of InterestUpdates a point of interest.
application/json application/xml
pointOfInterestId path string storeId path string path query string operation query string responseFormat query string
Get all POI application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointsOfInterest
Tags: Points of InterestGets all points of interest.
storeId path string langId query string responseFormat query string
Get POI by cell ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointsOfInterest/byCellId/{cellId}
Tags: Points of InterestGets points of interest by cell ID.
cellId path string storeId path string langId query string responseFormat query string
Get POI by POI type application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointsOfInterest/byPOIType/{poiType}
Tags: Points of InterestGets points of interest by POI type.
poiType path string storeId path string langId query string responseFormat query string
Get POIs by proximity application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointsOfInterest/byProximity
Tags: Points of Interest"Gets points of interest by proximity based on specified geolocation, POI type, and radius."
storeId path string langId query string latitude query string longitude query string radius query string poiType query string responseFormat query string
Get POI by region ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointsOfInterest/byRegionId/{regionId}
Tags: Points of InterestGets points of interest by region ID.
regionId path string storeId path string langId query string responseFormat query string
Get POI by status application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointsOfInterest/byStatus/{status}
Tags: Points of InterestGets a point of interest by status.
status path string storeId path string langId query string responseFormat query string
Get POI by tags application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointsOfInterest/byTag/{tag}
Tags: Points of InterestGets points of interest by tags. It will return the POIs whose tag contains the specified string.
tag path string storeId path string langId query string responseFormat query string
Get POI by XPath application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointsOfInterest/byXPath
Tags: Points of InterestGets a point of interest by XPath.
storeId path string xPath query string langId query string responseFormat query string
Get POI by zone ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/pointsOfInterest/byZoneId/{zoneId}
Tags: Points of InterestGets points of interest by zone ID.
zoneId path string storeId path string langId query string responseFormat query string
Get by geo node unique ID application/atom+xml application/json application/xml application/xhtml+xml
- 200 OK
No response was specified. Empty
GET /store/{storeId}/storelocator/byGeoNode/{geoId}
Tags: Store LocatorGets store location information by a geo node unique ID.
storeId The store identifier.
path string geoId The geo node unique identifier.
path string pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32) BeautyCenter The physical store attribute name that describes whether the store is a beauty center.
query string Type The physical store attribute name to describe the type of the store.
query string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } siteLevelStoreSearch If it is 'true', a site level physical search is performed. Otherwise, the physical store search is performed at the web store level. By default, it is 'true'.
query string , x ∈ { true , false }
Get by specified location application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"PhysicalStore": [
{
"Attribute": [
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Designer studio",
"displayValue": "true",
"name": "DesignerStudio",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Express Store",
"name": "Type",
"value": "Express Store"
},
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
}
],
"Description": [
{
"displayStoreName": "Calgary Circle Mall"
}
],
"addressLine": [
"300 MacLeod Tr"
],
"city": "Calgary",
"country": "Canada",
"latitude": "51.05000",
"longitude": "-114.05800",
"postalCode": "T2G 5R1 ",
"stateOrProvinceName": "Alberta",
"storeName": "Calgary Circle Mall",
"telephone1": "511.513.5789 ",
"uniqueID": "10037"
},
{
"Attribute": [
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Outlet Store",
"name": "Type",
"value": "Outlet Store"
},
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
}
],
"Description": [
{
"displayStoreName": "Calgary Mall"
}
],
"addressLine": [
"1025 Cameron Ave SW"
],
"city": "Calgary",
"country": "Canada",
"latitude": "51.03636",
"longitude": "-114.08640",
"postalCode": "T2T 0K4 ",
"stateOrProvinceName": "Alberta",
"storeName": "Calgary Mall",
"telephone1": "367.666.6666 ",
"uniqueID": "10026"
}
],
"recordSetComplete": "true",
"recordSetCount": "2",
"recordSetStartNumber": "0",
"recordSetTotal": "2",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/byGeoNode/10004?responseFormat=json",
"resourceName": "storelocator"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/storelocator/byLocation
Tags: Store LocatorGets store location information by a specified location.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } city The city.
query string state The state.
query string prov The province.
query string country The country.
query string radiusUOM The radius unit of measure.
query string BeautyCenter The physical store attribute name that describes whether the store is a beauty center.
query string Type The physical store attribute name to describe the type of the store.
query string radius The radius.
query string pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32) siteLevelStoreSearch If it is 'true', a site level physical search is performed. Otherwise, the physical store search is performed at the web store level. By default, it is 'true'.
query string , x ∈ { true , false }
Get by store unique ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"PhysicalStore": [
{
"Attribute": [
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Regular Store",
"name": "Type",
"value": "Regular Store"
},
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
}
],
"Description": [
{
"displayStoreName": "Markham Centre"
}
],
"addressLine": [
"8200 Warden Ave"
],
"city": "Markham",
"country": "Canada",
"latitude": "43.84600",
"longitude": "-79.33200",
"postalCode": "L6G 1C7 ",
"stateOrProvinceName": "Ontario",
"storeName": "Markham Centre",
"telephone1": "905.413.5555 ",
"uniqueID": "10003"
},
{
"Attribute": [
{
"displayName": "Designer studio",
"displayValue": "true",
"name": "DesignerStudio",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Express Store",
"name": "Type",
"value": "Express Store"
},
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
}
],
"Description": [
{
"displayStoreName": "Markville Mall"
}
],
"addressLine": [
"8000 McCowan Rd"
],
"city": "Markham",
"country": "Canada",
"latitude": "43.88900",
"longitude": "-79.29000",
"postalCode": "L3P 3J3 ",
"stateOrProvinceName": "Ontario",
"storeName": "Markville Mall",
"telephone1": "905.416.6666 ",
"uniqueID": "10004"
},
{
"Attribute": [
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Sushi restaurant",
"displayValue": "true",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Regular Store",
"name": "Type",
"value": "Regular Store"
},
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
}
],
"Description": [
{
"displayStoreName": "Warden Plaza"
}
],
"addressLine": [
"8250 Warden Ave"
],
"city": "Markham",
"country": "Canada",
"latitude": "43.85100",
"longitude": "-79.33300",
"postalCode": "L6G 1C7 ",
"stateOrProvinceName": "Ontario",
"storeName": "Warden Plaza",
"telephone1": "905.326.8647 ",
"uniqueID": "10039"
}
],
"recordSetComplete": "true",
"recordSetCount": "3",
"recordSetStartNumber": "0",
"recordSetTotal": "3",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/byLocation?city=markham&siteLevelStoreSearch=false",
"resourceName": "storelocator"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found No physical store is found for the criteria provided.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/storelocator/byStoreId/{uniqueId}
Tags: Store LocatorGets store location information by a store unique ID.
storeId The store identifier.
path string uniqueId The unique identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32)
Get by store unique IDs application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"PhysicalStore": [
{
"Attribute": [
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Regular Store",
"name": "Type",
"value": "Regular Store"
},
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
}
],
"Description": [
{
"displayStoreName": "Markham Centre"
}
],
"addressLine": [
"8200 Warden Ave"
],
"city": "Markham",
"country": "Canada",
"latitude": "43.84600",
"longitude": "-79.33200",
"postalCode": "L6G 1C7 ",
"stateOrProvinceName": "Ontario",
"storeName": "Markham Centre",
"telephone1": "905.413.5555 ",
"uniqueID": "10003"
}
],
"recordSetComplete": "true",
"recordSetCount": "1",
"recordSetStartNumber": "0",
"recordSetTotal": "1",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/byStoreId/10003",
"resourceName": "storelocator"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/storelocator/byStoreIds
Tags: Store LocatorGets store location information by one to n store unique IDs.
storeId The store identifier.
path string physicalStoreId A list of physical store unique identifiers.
query string[] responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32)
Get by specified coordinates application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"PhysicalStore": [
{
"Attribute": [
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Regular Store",
"name": "Type",
"value": "Regular Store"
},
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
}
],
"Description": [
{
"displayStoreName": "Markham Centre"
}
],
"addressLine": [
"8200 Warden Ave"
],
"city": "Markham",
"country": "Canada",
"latitude": "43.84600",
"longitude": "-79.33200",
"postalCode": "L6G 1C7 ",
"stateOrProvinceName": "Ontario",
"storeName": "Markham Centre",
"telephone1": "905.413.5555 ",
"uniqueID": "10003"
},
{
"Attribute": [
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Sushi restaurant",
"displayValue": "true",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Regular Store",
"name": "Type",
"value": "Regular Store"
},
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
}
],
"Description": [
{
"displayStoreName": "Warden Plaza"
}
],
"addressLine": [
"8250 Warden Ave"
],
"city": "Markham",
"country": "Canada",
"latitude": "43.85100",
"longitude": "-79.33300",
"postalCode": "L6G 1C7 ",
"stateOrProvinceName": "Ontario",
"storeName": "Warden Plaza",
"telephone1": "905.326.8647 ",
"uniqueID": "10039"
}
],
"recordSetComplete": "true",
"recordSetCount": "2",
"recordSetStartNumber": "0",
"recordSetTotal": "2",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/byStoreIds?physicalStoreId=10039&physicalStoreId=10003&responseFormat=json",
"resourceName": "storelocator"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/storelocator/latitude/{latitude}/longitude/{longitude}
Tags: Store LocatorGets store location information by specified coordinates.
storeId The store identifier.
path string latitude The latitude.
path string longitude The longitude.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } maxItems The maximum number of stores to return.
query string radiusUOM The radius unit of measure.
query string BeautyCenter The physical store attribute name that describes whether the store is a beauty center.
query string Type The physical store attribute name to describe the type of the store.
query string radius The radius.
query string siteLevelStoreSearch If it is 'true', a site level physical search is performed. Otherwise, the physical store search is performed at the web store level. By default, it is 'true'.
query string , x ∈ { true , false }
application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"PhysicalStore": [
{
"Attribute": [
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
},
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Sushi restaurant",
"displayValue": "true",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Regular Store",
"name": "Type",
"value": "Regular Store"
}
],
"Description": [
{
"displayStoreName": "Warden Plaza"
}
],
"addressLine": [
"8250 Warden Ave"
],
"city": "Markham",
"country": "Canada",
"distance": "0.5458207187651365",
"latitude": "43.85100",
"longitude": "-79.33300",
"postalCode": "L6G 1C7 ",
"stateOrProvinceName": "Ontario",
"storeName": "Warden Plaza",
"telephone1": "905.326.8647 ",
"uniqueID": "10039"
},
{
"Attribute": [
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
},
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Regular Store",
"name": "Type",
"value": "Regular Store"
}
],
"Description": [
{
"displayStoreName": "Markham Centre"
}
],
"addressLine": [
"8200 Warden Ave"
],
"city": "Markham",
"country": "Canada",
"distance": "0.666169063579425",
"latitude": "43.84600",
"longitude": "-79.33200",
"postalCode": "L6G 1C7 ",
"stateOrProvinceName": "Ontario",
"storeName": "Markham Centre",
"telephone1": "905.413.5555 ",
"uniqueID": "10003"
},
{
"Attribute": [
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
},
{
"displayName": "Designer studio",
"displayValue": "true",
"name": "DesignerStudio",
"value": "true"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Sushi restaurant",
"displayValue": "true",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Regular Store",
"name": "Type",
"value": "Regular Store"
}
],
"Description": [
{
"displayStoreName": "Alton Towers Plaza"
}
],
"addressLine": [
"250 Alton Towers Circle"
],
"city": "Toronto",
"country": "Canada",
"distance": "5.602484764287309",
"latitude": "43.82600",
"longitude": "-79.27700",
"postalCode": "M1V 3Z4 ",
"stateOrProvinceName": "Ontario",
"storeName": "Alton Towers Plaza",
"telephone1": "416.326.8647 ",
"uniqueID": "10042"
},
{
"Attribute": [
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
},
{
"displayName": "Designer studio",
"displayValue": "true",
"name": "DesignerStudio",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Express Store",
"name": "Type",
"value": "Express Store"
}
],
"Description": [
{
"displayStoreName": "Markville Mall"
}
],
"addressLine": [
"8000 McCowan Rd"
],
"city": "Markham",
"country": "Canada",
"distance": "5.9428276427935876",
"latitude": "43.88900",
"longitude": "-79.29000",
"postalCode": "L3P 3J3 ",
"stateOrProvinceName": "Ontario",
"storeName": "Markville Mall",
"telephone1": "905.416.6666 ",
"uniqueID": "10004"
},
{
"Attribute": [
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
},
{
"displayName": "Beauty center",
"displayValue": "true",
"name": "BeautyCenter",
"value": "true"
},
{
"displayName": "Sushi restaurant",
"displayValue": "true",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Express Store",
"name": "Type",
"value": "Express Store"
}
],
"Description": [
{
"displayStoreName": "Borough Plaza"
}
],
"addressLine": [
"300 Borough Drive"
],
"city": "Toronto",
"country": "Canada",
"distance": "10.639123055945683",
"latitude": "43.77500",
"longitude": "-79.25500",
"postalCode": "M1P 4P5 ",
"stateOrProvinceName": "Ontario",
"storeName": "Borough Plaza",
"telephone1": "416.134.5467 ",
"uniqueID": "10044"
},
{
"Attribute": [
{
"displayName": "Store hours",
"displayValue": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm<br />Sat: 9am - 7pm<br />Sun: 11am - 6pm<br />"
},
{
"displayName": "Cappuccino bar",
"displayValue": "true",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayName": "Designer studio",
"displayValue": "true",
"name": "DesignerStudio",
"value": "true"
},
{
"displayName": "Type",
"displayValue": "Express Store",
"name": "Type",
"value": "Express Store"
}
],
"Description": [
{
"displayStoreName": "Yorkdale Centre"
}
],
"addressLine": [
"3401 Dufferin Street"
],
"city": "North York",
"country": "Canada",
"distance": "12.575219484555985",
"latitude": "43.75200",
"longitude": "-79.42000",
"postalCode": "M2N 1A1 ",
"stateOrProvinceName": "Ontario",
"storeName": "Yorkdale Centre",
"telephone1": "905.411.1278 ",
"uniqueID": "10002"
}
],
"recordSetComplete": "true",
"recordSetCount": "6",
"recordSetStartNumber": "0",
"recordSetTotal": "6",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/latitude/43.848983/longitude/-79.3392102?maxItems=&siteLevelStoreSearch=false&responseFormat=json",
"resourceName": "storelocator"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
Schema definitions
com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary: object
- countryCodeStates: object[]
com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary.countryCodeStates - countries: com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary.countries
com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary.countries: object
com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary.countryCodeStates: object
- code: string
- displayName: string
com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateName: object
- stateDisplayName: string
- countryDisplayName: string
Empty: object
Empty model. Used as default value when no model is specified.
geonode-geonode: object
- GeoNode: object[]
geonode-geonode_item - recordSetComplete: string
- recordSetStartNumber: string (int64)
- recordSetCount: string (int64)
- recordSetTotal: string (int64)
geonode-geonode_item: object
- userDataField: object[]
geonode-geonode_item.userDataField - type: string
- Description: object[]
geonode-geonode_item.Description - uniqueID: string
- name: string
geonode-geonode_item.Description: object
- shortDescription: string
geonode-geonode_item.userDataField: object
- value: string
- key: string
storelocator-storelocator: object
- recordSetCount: string (int64)
- recordSetComplete: string
- recordSetTotal: string (int64)
- recordSetStartNumber: string (int64)
- PhysicalStore: object[]
storelocator-storelocator_item
storelocator-storelocator_item: object
- distance: string (double)
- Description: object[]
storelocator-storelocator_item.Description - storeName: string
- Attribute: object[]
storelocator-storelocator_item.Attribute - longitude: string (double)
- postalCode: string
- stateOrProvinceName: string
- uniqueID: string
- telephone1: string
- latitude: string (double)
- userDataField: object[]
storelocator-storelocator_item.userDataField - country: string
- city: string
- addressLine: string[]
string
storelocator-storelocator_item.Attribute: object
- displayValue: string
- displayName: string
- name: string
- value: string
storelocator-storelocator_item.Description: object
- displayStoreName: string
- fullImage: string
- thumbnail: string
storelocator-storelocator_item.userDataField: object
- value: string
- key: string