{
"openapi": "3.0.1",
"info": {
"title": "Store Locator",
"description": "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.",
"version": "9.1.20.0",
"x-introduced": "9.1.0.0"
},
"servers": [
{
"url": "https://{hostname}:{port}/wcs/resources",
"variables": {
"port": {
"default": "443",
"enum": [
"443",
"5443"
]
},
"hostname": {
"default": "localhost",
"enum": [
"localhost",
"test.hcl.com"
]
}
}
}
],
"externalDocs": {
"description": "Some REST services require authentication. HCL Commerce REST services are authenticated on secure and unsecured channels. This authentication can include the use of the WCToken and WCTrustedToken. To use REST services that require authentication, you must first get authentication data by using a supported identity services.\n\nAfter you obtain the authentication data, you must pass either the WCToken or WCTustedToken parameters, or both, within the HTTP header for every request that requires authentication. If a request is sent over HTTP, pass the WCToken parameter in the HTTP header. Do not pass the WCTrustedToken in HTTP requests, as the parameter value might display. Send both the WCToken and the WCTrustedToken parameters when the request is being sent over HTTPS.\n\nThe HCL Commerce REST APIs can also use session cookies that are created by the HCL Commerce store runtime for authentication. These cookies allow you to mix requests to the HCL Commerce REST APIs and the HCL Commerce store runtime within the same user session.\n\n",
"url": "https://help.hcltechsw.com/commerce/9.1.0/webservices/concepts/cwvrestauth.html?hl=rest%2Cauthentication"
},
"tags": [
{
"name": "Store Locator",
"description": "Provides RESTful services to get store location details. It performs the service by delegating to the PhysicalStore and GeoNode BOD services."
},
{
"name": "Country",
"description": "Provides RESTful services to get countries or regions and states or provinces information."
},
{
"name": "Geonode",
"description": "Provides RESTful services to get geo node details. It performs the service by delegating to the GeoNode BOD service."
}
],
"paths": {
"/store/{storeId}/storelocator/byLocation": {
"get": {
"tags": [
"Store Locator"
],
"summary": "Get by specified location",
"description": "Gets store location information by a specified location.",
"operationId": "StoreLocator-findGeoNodeByGeoLocation",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "responseFormat",
"in": "query",
"description": "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.",
"schema": {
"type": "string",
"enum": [
"xml",
"json"
]
}
},
{
"name": "city",
"in": "query",
"description": "The city.",
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "The state.",
"schema": {
"type": "string"
}
},
{
"name": "prov",
"in": "query",
"description": "The province.",
"schema": {
"type": "string"
}
},
{
"name": "country",
"in": "query",
"description": "The country.",
"schema": {
"type": "string"
}
},
{
"name": "radiusUOM",
"in": "query",
"description": "The radius unit of measure.",
"schema": {
"type": "string"
}
},
{
"name": "BeautyCenter",
"in": "query",
"description": "The physical store attribute name that describes whether the store is a beauty center.",
"schema": {
"type": "string"
}
},
{
"name": "Type",
"in": "query",
"description": "The physical store attribute name to describe the type of the store.",
"schema": {
"type": "string"
}
},
{
"name": "radius",
"in": "query",
"description": "The radius.",
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "siteLevelStoreSearch",
"in": "query",
"description": "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'.",
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
},
"example": {
"recordSetStartNumber": "0",
"recordSetComplete": "true",
"recordSetCount": "3",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/byLocation?city=markham&siteLevelStoreSearch=false",
"PhysicalStore": [
{
"city": "Markham",
"Description": [
{
"displayStoreName": "Markham Centre"
}
],
"storeName": "Markham Centre",
"Attribute": [
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "Regular Store",
"displayName": "Type",
"name": "Type",
"value": "Regular Store"
},
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
}
],
"longitude": -79.332,
"latitude": "43.84600",
"stateOrProvinceName": "Ontario",
"uniqueID": "10003",
"telephone1": "905.413.5555 ",
"postalCode": "L6G 1C7 ",
"country": "Canada",
"addressLine": [
"8200 Warden Ave"
]
},
{
"city": "Markham",
"Description": [
{
"displayStoreName": "Markville Mall"
}
],
"storeName": "Markville Mall",
"Attribute": [
{
"displayValue": "true",
"displayName": "Designer studio",
"name": "DesignerStudio",
"value": "true"
},
{
"displayValue": "Express Store",
"displayName": "Type",
"name": "Type",
"value": "Express Store"
},
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
}
],
"longitude": -79.29,
"latitude": "43.88900",
"stateOrProvinceName": "Ontario",
"uniqueID": "10004",
"telephone1": "905.416.6666 ",
"postalCode": "L3P 3J3 ",
"country": "Canada",
"addressLine": [
"8000 McCowan Rd"
]
},
{
"city": "Markham",
"Description": [
{
"displayStoreName": "Warden Plaza"
}
],
"storeName": "Warden Plaza",
"Attribute": [
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Sushi restaurant",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayValue": "Regular Store",
"displayName": "Type",
"name": "Type",
"value": "Regular Store"
},
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
}
],
"longitude": -79.333,
"latitude": "43.85100",
"stateOrProvinceName": "Ontario",
"uniqueID": "10039",
"telephone1": "905.326.8647 ",
"postalCode": "L6G 1C7 ",
"country": "Canada",
"addressLine": [
"8250 Warden Ave"
]
}
],
"resourceName": "storelocator",
"recordSetTotal": "3"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"404": {
"description": "No physical store is found for the criteria provided.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
},
"/store/{storeId}/country/country_state_list": {
"get": {
"tags": [
"Country"
],
"summary": "Get countries and regions",
"description": "Gets a list of countries or regions with the corresponding states or provinces.",
"operationId": "Country-findCountryStateList",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profileName",
"in": "query",
"description": "Profile name. Profiles determine the subset of data returned by a query. Default profile name = IBM_countryStateList_Summary.",
"schema": {
"type": "string",
"enum": [
"IBM_countryStateList_Summary"
]
}
},
{
"name": "countryCode",
"in": "query",
"description": "The country or region abbreviation code.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary"
},
"example": {
"countries": [
{
"states": [],
"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": [
{
"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": 1,
"code": "CA",
"displayName": "Canada"
},
{
"states": [],
"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": [
{
"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": 81,
"code": "JP",
"displayName": "Japan"
},
{
"states": [],
"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": [
{
"code": "PR",
"displayName": "Puerto Rico"
}
],
"callingCode": "+1-778",
"code": "PR",
"displayName": "Puerto Rico"
},
{
"states": [],
"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": [
{
"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": 1,
"code": "US",
"displayName": "United States"
},
{
"states": [],
"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"
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
},
"/store/{storeId}/storelocator/byStoreId/{uniqueId}": {
"get": {
"tags": [
"Store Locator"
],
"summary": "Get by store unique ID",
"description": "Gets store location information by a store unique ID.",
"operationId": "StoreLocator-findByStoreUniqueId",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "uniqueId",
"in": "path",
"description": "The unique identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "responseFormat",
"in": "query",
"description": "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.",
"schema": {
"type": "string",
"enum": [
"xml",
"json"
]
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
},
"example": {
"recordSetStartNumber": "0",
"recordSetComplete": "true",
"recordSetCount": "1",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/byStoreId/10003",
"PhysicalStore": [
{
"city": "Markham",
"Description": [
{
"displayStoreName": "Markham Centre"
}
],
"storeName": "Markham Centre",
"Attribute": [
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "Regular Store",
"displayName": "Type",
"name": "Type",
"value": "Regular Store"
},
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
}
],
"longitude": -79.332,
"latitude": "43.84600",
"stateOrProvinceName": "Ontario",
"uniqueID": "10003",
"telephone1": "905.413.5555 ",
"postalCode": "L6G 1C7 ",
"country": "Canada",
"addressLine": [
"8200 Warden Ave"
]
}
],
"resourceName": "storelocator",
"recordSetTotal": "1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
},
"/store/{storeId}/country/country_state_name": {
"get": {
"tags": [
"Country"
],
"summary": "Get display name of countries and regions",
"description": "Gets the display name of a country and/or a state.",
"operationId": "Country-findCountryStateName",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profileName",
"in": "query",
"description": "Profile name. Profiles determine the subset of data returned by a query. The default profile name is IBM_countryStateName.",
"schema": {
"type": "string",
"enum": [
"IBM_countryStateName"
]
}
},
{
"name": "countryCode",
"in": "query",
"description": "The country or region abbreviation code.",
"schema": {
"type": "string"
}
},
{
"name": "stateCode",
"in": "query",
"description": "The state or province abbreviation code.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateName"
},
"example": {
"stateDisplayName": "Ontario",
"countryDisplayName": "Canada"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateName"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateName"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateName"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
},
"/store/{storeId}/storelocator/byStoreIds": {
"get": {
"tags": [
"Store Locator"
],
"summary": "Get by store unique IDs",
"description": "Gets store location information by one to n store unique IDs.",
"operationId": "StoreLocator-findByStoreUniqueIds",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "physicalStoreId",
"in": "query",
"description": "A list of physical store unique identifiers.",
"required": true,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "responseFormat",
"in": "query",
"description": "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.",
"schema": {
"type": "string",
"enum": [
"xml",
"json"
]
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
},
"example": {
"recordSetStartNumber": "0",
"recordSetComplete": "true",
"recordSetCount": "2",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/byStoreIds?physicalStoreId=10039&physicalStoreId=10003&responseFormat=json",
"PhysicalStore": [
{
"city": "Markham",
"Description": [
{
"displayStoreName": "Markham Centre"
}
],
"storeName": "Markham Centre",
"Attribute": [
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "Regular Store",
"displayName": "Type",
"name": "Type",
"value": "Regular Store"
},
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
}
],
"longitude": -79.332,
"latitude": "43.84600",
"stateOrProvinceName": "Ontario",
"uniqueID": "10003",
"telephone1": "905.413.5555 ",
"postalCode": "L6G 1C7 ",
"country": "Canada",
"addressLine": [
"8200 Warden Ave"
]
},
{
"city": "Markham",
"Description": [
{
"displayStoreName": "Warden Plaza"
}
],
"storeName": "Warden Plaza",
"Attribute": [
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Sushi restaurant",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayValue": "Regular Store",
"displayName": "Type",
"name": "Type",
"value": "Regular Store"
},
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
}
],
"longitude": -79.333,
"latitude": "43.85100",
"stateOrProvinceName": "Ontario",
"uniqueID": "10039",
"telephone1": "905.326.8647 ",
"postalCode": "L6G 1C7 ",
"country": "Canada",
"addressLine": [
"8250 Warden Ave"
]
}
],
"resourceName": "storelocator",
"recordSetTotal": "2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
},
"/store/{storeId}/storelocator/latitude/{latitude}/longitude/{longitude}": {
"get": {
"tags": [
"Store Locator"
],
"summary": "Get by specified coordinates",
"description": "Gets store location information by specified coordinates.",
"operationId": "StoreLocator-findStores",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "latitude",
"in": "path",
"description": "The latitude.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "longitude",
"in": "path",
"description": "The longitude.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "responseFormat",
"in": "query",
"description": "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.",
"schema": {
"type": "string",
"enum": [
"xml",
"json"
]
}
},
{
"name": "maxItems",
"in": "query",
"description": "The maximum number of stores to return.",
"schema": {
"type": "string"
}
},
{
"name": "radiusUOM",
"in": "query",
"description": "The radius unit of measure.",
"schema": {
"type": "string"
}
},
{
"name": "BeautyCenter",
"in": "query",
"description": "The physical store attribute name that describes whether the store is a beauty center.",
"schema": {
"type": "string"
}
},
{
"name": "Type",
"in": "query",
"description": "The physical store attribute name to describe the type of the store.",
"schema": {
"type": "string"
}
},
{
"name": "radius",
"in": "query",
"description": "The radius.",
"schema": {
"type": "string"
}
},
{
"name": "siteLevelStoreSearch",
"in": "query",
"description": "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'.",
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
},
"example": {
"recordSetStartNumber": "0",
"recordSetComplete": "true",
"recordSetCount": "6",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/latitude/43.848983/longitude/-79.3392102?maxItems=&siteLevelStoreSearch=false&responseFormat=json",
"PhysicalStore": [
{
"distance": "0.5458207187651365",
"Description": [
{
"displayStoreName": "Warden Plaza"
}
],
"storeName": "Warden Plaza",
"Attribute": [
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
},
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Sushi restaurant",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayValue": "Regular Store",
"displayName": "Type",
"name": "Type",
"value": "Regular Store"
}
],
"longitude": -79.333,
"latitude": "43.85100",
"stateOrProvinceName": "Ontario",
"uniqueID": "10039",
"telephone1": "905.326.8647 ",
"postalCode": "L6G 1C7 ",
"country": "Canada",
"city": "Markham",
"addressLine": [
"8250 Warden Ave"
]
},
{
"distance": "0.666169063579425",
"Description": [
{
"displayStoreName": "Markham Centre"
}
],
"storeName": "Markham Centre",
"Attribute": [
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
},
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "Regular Store",
"displayName": "Type",
"name": "Type",
"value": "Regular Store"
}
],
"longitude": -79.332,
"latitude": "43.84600",
"stateOrProvinceName": "Ontario",
"uniqueID": "10003",
"telephone1": "905.413.5555 ",
"postalCode": "L6G 1C7 ",
"country": "Canada",
"city": "Markham",
"addressLine": [
"8200 Warden Ave"
]
},
{
"distance": "5.602484764287309",
"Description": [
{
"displayStoreName": "Alton Towers Plaza"
}
],
"storeName": "Alton Towers Plaza",
"Attribute": [
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
},
{
"displayValue": "true",
"displayName": "Designer studio",
"name": "DesignerStudio",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Sushi restaurant",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayValue": "Regular Store",
"displayName": "Type",
"name": "Type",
"value": "Regular Store"
}
],
"longitude": -79.277,
"latitude": "43.82600",
"stateOrProvinceName": "Ontario",
"uniqueID": "10042",
"telephone1": "416.326.8647 ",
"postalCode": "M1V 3Z4 ",
"country": "Canada",
"city": "Toronto",
"addressLine": [
"250 Alton Towers Circle"
]
},
{
"distance": "5.9428276427935876",
"Description": [
{
"displayStoreName": "Markville Mall"
}
],
"storeName": "Markville Mall",
"Attribute": [
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
},
{
"displayValue": "true",
"displayName": "Designer studio",
"name": "DesignerStudio",
"value": "true"
},
{
"displayValue": "Express Store",
"displayName": "Type",
"name": "Type",
"value": "Express Store"
}
],
"longitude": -79.29,
"latitude": "43.88900",
"stateOrProvinceName": "Ontario",
"uniqueID": "10004",
"telephone1": "905.416.6666 ",
"postalCode": "L3P 3J3 ",
"country": "Canada",
"city": "Markham",
"addressLine": [
"8000 McCowan Rd"
]
},
{
"distance": "10.639123055945683",
"Description": [
{
"displayStoreName": "Borough Plaza"
}
],
"storeName": "Borough Plaza",
"Attribute": [
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
},
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Sushi restaurant",
"name": "SushiRestaurant",
"value": "true"
},
{
"displayValue": "Express Store",
"displayName": "Type",
"name": "Type",
"value": "Express Store"
}
],
"longitude": -79.255,
"latitude": "43.77500",
"stateOrProvinceName": "Ontario",
"uniqueID": "10044",
"telephone1": "416.134.5467 ",
"postalCode": "M1P 4P5 ",
"country": "Canada",
"city": "Toronto",
"addressLine": [
"300 Borough Drive"
]
},
{
"distance": "12.575219484555985",
"Description": [
{
"displayStoreName": "Yorkdale Centre"
}
],
"storeName": "Yorkdale Centre",
"Attribute": [
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Designer studio",
"name": "DesignerStudio",
"value": "true"
},
{
"displayValue": "Express Store",
"displayName": "Type",
"name": "Type",
"value": "Express Store"
}
],
"longitude": -79.42,
"latitude": "43.75200",
"stateOrProvinceName": "Ontario",
"uniqueID": "10002",
"telephone1": "905.411.1278 ",
"postalCode": "M2N 1A1 ",
"country": "Canada",
"city": "North York",
"addressLine": [
"3401 Dufferin Street"
]
}
],
"resourceName": "storelocator",
"recordSetTotal": "6"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
},
"/store/{storeId}/storelocator/byGeoNode/{geoId}": {
"get": {
"tags": [
"Store Locator"
],
"summary": "Get by geo node unique ID",
"description": "Gets store location information by a geo node unique ID.",
"operationId": "StoreLocator-findGeoNodeByGeoId",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "geoId",
"in": "path",
"description": "The geo node unique identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "BeautyCenter",
"in": "query",
"description": "The physical store attribute name that describes whether the store is a beauty center.",
"schema": {
"type": "string"
}
},
{
"name": "Type",
"in": "query",
"description": "The physical store attribute name to describe the type of the store.",
"schema": {
"type": "string"
}
},
{
"name": "responseFormat",
"in": "query",
"description": "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.",
"schema": {
"type": "string",
"enum": [
"xml",
"json"
]
}
},
{
"name": "siteLevelStoreSearch",
"in": "query",
"description": "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'.",
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
},
"example": {
"recordSetStartNumber": "0",
"recordSetComplete": "true",
"recordSetCount": "2",
"resourceId": "http://localhost:80/wcs/resources/store/10001/storelocator/byGeoNode/10004?responseFormat=json",
"PhysicalStore": [
{
"city": "Calgary",
"Description": [
{
"displayStoreName": "Calgary Circle Mall"
}
],
"storeName": "Calgary Circle Mall",
"Attribute": [
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Designer studio",
"name": "DesignerStudio",
"value": "true"
},
{
"displayValue": "Express Store",
"displayName": "Type",
"name": "Type",
"value": "Express Store"
},
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
}
],
"longitude": -114.058,
"latitude": "51.05000",
"stateOrProvinceName": "Alberta",
"uniqueID": "10037",
"telephone1": "511.513.5789 ",
"postalCode": "T2G 5R1 ",
"country": "Canada",
"addressLine": [
"300 MacLeod Tr"
]
},
{
"city": "Calgary",
"Description": [
{
"displayStoreName": "Calgary Mall"
}
],
"storeName": "Calgary Mall",
"Attribute": [
{
"displayValue": "true",
"displayName": "Beauty center",
"name": "BeautyCenter",
"value": "true"
},
{
"displayValue": "true",
"displayName": "Cappuccino bar",
"name": "CappuccinoBar",
"value": "true"
},
{
"displayValue": "Outlet Store",
"displayName": "Type",
"name": "Type",
"value": "Outlet Store"
},
{
"displayValue": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
",
"displayName": "Store hours",
"name": "StoreHours",
"value": "Mon-Fri: 10am - 9pm
Sat: 9am - 7pm
Sun: 11am - 6pm
"
}
],
"longitude": -114.0864,
"latitude": "51.03636",
"stateOrProvinceName": "Alberta",
"uniqueID": "10026",
"telephone1": "367.666.6666 ",
"postalCode": "T2T 0K4 ",
"country": "Canada",
"addressLine": [
"1025 Cameron Ave SW"
]
}
],
"resourceName": "storelocator",
"recordSetTotal": "2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/storelocator-storelocator"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
},
"/store/{storeId}/geonode/byParentGeoNode/{parentgeoid}": {
"get": {
"tags": [
"Geonode"
],
"summary": "Gets by parent unique ID",
"description": "Gets 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.",
"operationId": "Geonode-findGeoByParentGeoId",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "parentgeoid",
"in": "path",
"description": "The parent geo node identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "responseFormat",
"in": "query",
"description": "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.",
"schema": {
"type": "string",
"enum": [
"json"
]
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/geonode-geonode"
},
"example": {
"recordSetStartNumber": "0",
"recordSetComplete": "true",
"recordSetCount": "7",
"resourceId": "http://localhost:80/wcs/resources/store/10001/geonode/byParentGeoNode/10003?responseFormat=json",
"GeoNode": [
{
"type": "CITY",
"Description": [
{
"shortDescription": "Calgary"
}
],
"uniqueID": "10004",
"name": "Calgary"
},
{
"type": "CITY",
"Description": [
{
"shortDescription": "Edmonton"
}
],
"uniqueID": "10005",
"name": "Edmonton"
},
{
"type": "CITY",
"Description": [
{
"shortDescription": "Lethbridge"
}
],
"uniqueID": "10006",
"name": "Lethbridge"
},
{
"type": "CITY",
"Description": [
{
"shortDescription": "Medicine Hat"
}
],
"uniqueID": "10007",
"name": "Medicine Hat"
},
{
"type": "CITY",
"Description": [
{
"shortDescription": "Red Deer"
}
],
"uniqueID": "10008",
"name": "Red Deer"
},
{
"type": "CITY",
"Description": [
{
"shortDescription": "St. Albert"
}
],
"uniqueID": "10009",
"name": "St. Albert"
},
{
"type": "CITY",
"Description": [
{
"shortDescription": "Strathcona County"
}
],
"uniqueID": "10010",
"name": "Strathcona County"
}
],
"resourceName": "geonode",
"recordSetTotal": "7"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/geonode-geonode"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/geonode-geonode"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/geonode-geonode"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
},
"/store/{storeId}/geonode": {
"get": {
"tags": [
"Geonode"
],
"summary": "Get by query",
"description": "Finds geo nodes based on query name. See each query for details on input and output.",
"operationId": "Geonode-findByQuery",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "q",
"in": "query",
"description": "The query name.",
"required": true,
"schema": {
"type": "string",
"enum": [
"byGeoNodeTypeAndName"
]
}
},
{
"name": "type",
"in": "query",
"description": "The store type.",
"required": true,
"schema": {
"type": "string",
"enum": [
"CITY",
"CNTY",
"PROV",
"STAT"
]
}
},
{
"name": "name",
"in": "query",
"description": "The store name.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "siteLevelSearch",
"in": "query",
"description": "The site level search flag. If it is 'true', a site level search will be performed; otherwise, a store level search will be performed. Optional parameter; when it is not set, it is defaulted to 'true'..",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/geonode-geonode"
},
{
"$ref": "#/components/schemas/geonode-geonodes"
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
},
"/store/{storeId}/geonode/byTopGeoNode": {
"get": {
"tags": [
"Geonode"
],
"summary": "Gets by site top-nodes",
"description": "Gets the top geo nodes for the site. The response schema will flatten the result if a single object is returned in the list.",
"operationId": "Geonode-findTopGeoNodes",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "The store identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "responseFormat",
"in": "query",
"description": "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.",
"schema": {
"type": "string",
"enum": [
"xml",
"json"
]
}
},
{
"name": "siteLevelSearch",
"in": "query",
"description": "The site level search flag. If it is 'true', a site level search will be performed; otherwise, a store level search will be performed. Optional parameter; when it is not set, it is defaulted to 'true'..",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
],
"responses": {
"200": {
"description": "The requested completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/geonode-geonode"
},
"example": {
"recordSetStartNumber": "0",
"recordSetComplete": "true",
"recordSetCount": "2",
"resourceId": "http://localhost:80/wcs/resources/store/10001/geonode/byTopGeoNode?siteLevelSearch=false&responseFormat=json",
"GeoNode": [
{
"type": "CNTY",
"Description": [
{
"shortDescription": "Canada"
}
],
"uniqueID": "10001",
"name": "Canada"
},
{
"type": "CNTY",
"Description": [
{
"shortDescription": "United States"
}
],
"uniqueID": "10002",
"name": "United States"
}
],
"resourceName": "geonode",
"recordSetTotal": "2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/geonode-geonode"
}
},
"application/xhtml+xml": {
"schema": {
"$ref": "#/components/schemas/geonode-geonode"
}
},
"application/atom+xml": {
"schema": {
"$ref": "#/components/schemas/geonode-geonode"
}
}
}
},
"400": {
"description": "Bad request. The request could not be understood by the server due to malformed syntax.",
"content": {}
},
"401": {
"description": "Not authenticated. The user session is not valid.",
"content": {}
},
"403": {
"description": "The user is not authorized to perform the specified request.",
"content": {}
},
"500": {
"description": "Internal server error. For details, see the server log files.",
"content": {}
}
}
}
}
},
"components": {
"schemas": {
"storelocator-storelocator_item.Attribute": {
"type": "object",
"properties": {
"displayValue": {
"type": "string"
},
"displayName": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"storelocator-storelocator_item.userDataField": {
"required": [
"key"
],
"type": "object",
"properties": {
"value": {
"type": "string"
},
"key": {
"type": "string"
}
}
},
"storelocator-storelocator": {
"type": "object",
"properties": {
"resourceId": {
"type": "string"
},
"recordSetCount": {
"type": "string",
"format": "int32"
},
"recordSetComplete": {
"type": "string"
},
"recordSetTotal": {
"type": "string",
"format": "int32"
},
"recordSetStartNumber": {
"type": "string",
"format": "int32"
},
"resourceName": {
"type": "string"
},
"PhysicalStore": {
"type": "array",
"items": {
"$ref": "#/components/schemas/storelocator-storelocator_item"
}
}
}
},
"com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary": {
"type": "object",
"x-graphql-type-name": "countryStateListsummary",
"properties": {
"countryCodeStates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary.countryCodeStates"
},
"nullable": true
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary.countries"
}
}
}
},
"com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary.countries": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string"
},
"displayName": {
"type": "string"
},
"callingCode": {
"type": "string"
},
"states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary.countryCodeStates"
}
}
}
},
"com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateList_Summary.countryCodeStates": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string"
},
"displayName": {
"type": "string"
}
}
},
"geonode-geonode_item.userDataField": {
"required": [
"key"
],
"type": "object",
"properties": {
"value": {
"type": "string"
},
"key": {
"type": "string"
}
}
},
"geonode-geonodes": {
"type": "object",
"properties": {
"resourceId": {
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shortDescription": {
"type": "string"
}
}
}
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"recordSetComplete": {
"type": "string"
},
"recordSetStartNumber": {
"type": "string",
"format": "int32"
},
"recordSetCount": {
"type": "string",
"format": "int32"
},
"recordSetTotal": {
"type": "string",
"format": "int32"
},
"resourceName": {
"type": "string"
},
"uniqueID": {
"type": "string"
}
}
},
"geonode-geonode": {
"type": "object",
"properties": {
"resourceId": {
"type": "string"
},
"GeoNode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/geonode-geonode_item"
}
},
"recordSetComplete": {
"type": "string"
},
"recordSetStartNumber": {
"type": "string",
"format": "int32"
},
"recordSetCount": {
"type": "string",
"format": "int32"
},
"recordSetTotal": {
"type": "string",
"format": "int32"
},
"resourceName": {
"type": "string"
}
}
},
"com.ibm.commerce.user.beans.CountryStateListDataBean_IBM_countryStateName": {
"type": "object",
"x-graphql-type-name": "countryStateName",
"properties": {
"stateDisplayName": {
"type": "string",
"nullable": true
},
"countryDisplayName": {
"type": "string",
"nullable": true
}
}
},
"geonode-geonode_item": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"Description": {
"type": "array",
"items": {
"$ref": "#/components/schemas/geonode-geonode_item.Description"
}
},
"uniqueID": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"geonode-geonode_item.Description": {
"type": "object",
"properties": {
"shortDescription": {
"type": "string"
}
}
},
"storelocator-storelocator_item": {
"required": [
"telephone1"
],
"type": "object",
"properties": {
"distance": {
"type": "string",
"format": "double"
},
"Description": {
"type": "array",
"items": {
"$ref": "#/components/schemas/storelocator-storelocator_item.Description"
}
},
"storeName": {
"type": "string"
},
"Attribute": {
"type": "array",
"items": {
"$ref": "#/components/schemas/storelocator-storelocator_item.Attribute"
}
},
"longitude": {
"type": "string",
"format": "double"
},
"postalCode": {
"type": "string"
},
"stateOrProvinceName": {
"type": "string"
},
"uniqueID": {
"type": "string"
},
"telephone1": {
"type": "string"
},
"latitude": {
"type": "string",
"format": "double"
},
"country": {
"type": "string"
},
"city": {
"type": "string"
},
"addressLine": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"storelocator-storelocator_item.Description": {
"type": "object",
"properties": {
"displayStoreName": {
"type": "string"
}
}
},
"Empty": {
"type": "object",
"description": "Empty model. Used as default value when no model is specified."
}
},
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic"
}
}
},
"security": [
{
"basicAuth": []
}
],
"x-aes-documentation": {
"gettingstarted": [
{
"content": "HCL Commerce REST services support JSON and XML formats for input and output data by default. The default format is JSON. When an XML String is sent to a REST service, you must set Content-Type HTTP header to be \"application/xml\". The REST service converts the XML input data to the JSON format that is accepted by REST services. Therefore, your input XML format must follow a certain structure so that it can be transformed to the JSON object that is accepted by REST services. See more here: ",
"codeSnippets": [],
"name": "Response formats"
},
{
"content": "Preview tokens are encrypted strings that encapsulates a set of preview options and restrictions on when and where the token can be used. Any user who is authorized to access your server and has a preview token, can complete preview actions in the same store for which that token is generated. See more here: ",
"codeSnippets": [],
"name": "Preview tokens"
},
{
"content": "Some HCL Commerce REST services require a request to be sent over HTTPS. Learn more here: ",
"codeSnippets": [],
"name": "Secure Sockets Layer"
}
]
}
}