OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Gets a list of countries or regions with the corresponding states or provinces. 4 # 5 # Equivalent to GET /store/{storeId}/country/country_state_list 6 # 7 # Arguments 8 # countryCode: The country or region abbreviation code. 9 # profileName: Profile name. Profiles determine the subset of 10 # data returned by a query. Default profile name = IBM_countryStateList_Summary. 11 # storeId: The store identifier. 12 ( 13 : String, 14 : ProfileName, 15 : String! 16 ): countryStateListsummary 253 17 # Gets the display name of a country and/or a state. 18 # 19 # Equivalent to GET /store/{storeId}/country/country_state_name 20 # 21 # Arguments 22 # countryCode: The country or region abbreviation code. 23 # profileName: Profile name. Profiles determine the subset of 24 # data returned by a query. The default profile name is IBM_countryStateName. 25 # stateCode: The state or province abbreviation code. 26 # storeId: The store identifier. 27 ( 28 : String, 29 : ProfileName2, 30 : String, 31 : String! 32 ): countryStateName 253 33 # Finds geo nodes based on query name. See each query for details on input and 34 # output. 35 # 36 # Equivalent to GET /store/{storeId}/geonode 37 # 38 # Arguments 39 # name: The store name. 40 # q: The query name. 41 # siteLevelSearch: The site level search flag. If it is 'true', 42 # a site level search will be performed; otherwise, a store level search will be 43 # performed. Optional parameter; when it is not set, it is defaulted to 'true'.. 44 # storeId: The store identifier. 45 # type: The store type. 46 ( 47 : String!, 48 : Q!, 49 : SiteLevelSearch, 50 : String!, 51 : Type! 52 ): StoreGeonode 253 53 # Gets the geo nodes by the parent geo node unique ID. The response schema will 54 # flatten the result if a single object is returned in the list. 55 # 56 # Equivalent to GET /store/{storeId}/geonode/byParentGeoNode/{parentgeoid} 57 # 58 # Arguments 59 # parentgeoid: The parent geo node identifier. 60 # responseFormat: The response format. Valid values are json and 61 # xml. If the request contains an input body, it must use the format specified in 62 # responseFormat. If the responseFormat is not specified, the accept HTTP header 63 # determines the format of the response. If the accept HTTP header is not 64 # specified then default response format is json. 65 # storeId: The store identifier. 66 ( 67 : String!, 68 : ResponseFormat2, 69 : String! 70 ): GeonodeGeonode 253 71 # Gets the top geo nodes for the site. The response schema will flatten the result 72 # if a single object is returned in the list. 73 # 74 # Equivalent to GET /store/{storeId}/geonode/byTopGeoNode 75 # 76 # Arguments 77 # responseFormat: The response format. Valid values are json and 78 # xml. If the request contains an input body, it must use the format specified in 79 # responseFormat. If the responseFormat is not specified, the accept HTTP header 80 # determines the format of the response. If the accept HTTP header is not 81 # specified then default response format is json. 82 # siteLevelSearch: The site level search flag. If it is 'true', 83 # a site level search will be performed; otherwise, a store level search will be 84 # performed. Optional parameter; when it is not set, it is defaulted to 'true'.. 85 # storeId: The store identifier. 86 ( 87 : ResponseFormat, 88 : SiteLevelSearch, 89 : String! 90 ): GeonodeGeonode 253 91 # Gets store location information by a store unique ID. 92 # 93 # Equivalent to GET /store/{storeId}/storelocator/byStoreId/{uniqueId} 94 # 95 # Arguments 96 # pageNumber: Page number. Valid values are positive integers 97 # starting at 1. Use pageNumber with pageSize. 98 # pageSize: Page size. Used to limit the amount of data returned 99 # by a query. Valid values are integers starting with 1. Use pageSize with 100 # pageNumber. 101 # responseFormat: The response format. Valid values are json and 102 # xml. If the request contains an input body, it must use the format specified in 103 # responseFormat. If the responseFormat is not specified, the accept HTTP header 104 # determines the format of the response. If the accept HTTP header is not 105 # specified then default response format is json. 106 # storeId: The store identifier. 107 # uniqueId: The unique identifier. 108 ( 109 : Int, 110 : Int, 111 : ResponseFormat, 112 : String!, 113 : String! 114 ): StorelocatorStorelocator 253 115 # Gets store location information by one to n store unique IDs. 116 # 117 # Equivalent to GET /store/{storeId}/storelocator/byStoreIds 118 # 119 # Arguments 120 # pageNumber: Page number. Valid values are positive integers 121 # starting at 1. Use pageNumber with pageSize. 122 # pageSize: Page size. Used to limit the amount of data returned 123 # by a query. Valid values are integers starting with 1. Use pageSize with 124 # pageNumber. 125 # physicalStoreId: A list of physical store unique identifiers. 126 # responseFormat: The response format. Valid values are json and 127 # xml. If the request contains an input body, it must use the format specified in 128 # responseFormat. If the responseFormat is not specified, the accept HTTP header 129 # determines the format of the response. If the accept HTTP header is not 130 # specified then default response format is json. 131 # storeId: The store identifier. 132 ( 133 : Int, 134 : Int, 135 : [String]!, 136 : ResponseFormat, 137 : String! 138 ): StorelocatorStorelocator 253 139 # Gets store location information by a geo node unique ID. 140 # 141 # Equivalent to GET /store/{storeId}/storelocator/byGeoNode/{geoId} 142 # 143 # Arguments 144 # beautyCenter: The physical store attribute name that describes 145 # whether the store is a beauty center. 146 # geoId: The geo node unique identifier. 147 # pageNumber: Page number. Valid values are positive integers 148 # starting at 1. Use pageNumber with pageSize. 149 # pageSize: Page size. Used to limit the amount of data returned 150 # by a query. Valid values are integers starting with 1. Use pageSize with 151 # pageNumber. 152 # responseFormat: The response format. Valid values are json and 153 # xml. If the request contains an input body, it must use the format specified in 154 # responseFormat. If the responseFormat is not specified, the accept HTTP header 155 # determines the format of the response. If the accept HTTP header is not 156 # specified then default response format is json. 157 # siteLevelStoreSearch: If it is 'true', a site level physical 158 # search is performed. Otherwise, the physical store search is performed at the 159 # web store level. By default, it is 'true'. 160 # storeId: The store identifier. 161 # type: The physical store attribute name to describe the type of 162 # the store. 163 ( 164 : String, 165 : String!, 166 : Int, 167 : Int, 168 : ResponseFormat, 169 : SiteLevelStoreSearch, 170 : String!, 171 : String 172 ): StorelocatorStorelocator 253 173 # Gets store location information by a specified location. 174 # 175 # Equivalent to GET /store/{storeId}/storelocator/byLocation 176 # 177 # Arguments 178 # beautyCenter: The physical store attribute name that describes 179 # whether the store is a beauty center. 180 # city: The city. 181 # country: The country. 182 # pageNumber: Page number. Valid values are positive integers 183 # starting at 1. Use pageNumber with pageSize. 184 # pageSize: Page size. Used to limit the amount of data returned 185 # by a query. Valid values are integers starting with 1. Use pageSize with 186 # pageNumber. 187 # prov: The province. 188 # radius: The radius. 189 # radiusUOM: The radius unit of measure. 190 # responseFormat: The response format. Valid values are json and 191 # xml. If the request contains an input body, it must use the format specified in 192 # responseFormat. If the responseFormat is not specified, the accept HTTP header 193 # determines the format of the response. If the accept HTTP header is not 194 # specified then default response format is json. 195 # siteLevelStoreSearch: If it is 'true', a site level physical 196 # search is performed. Otherwise, the physical store search is performed at the 197 # web store level. By default, it is 'true'. 198 # state: The state. 199 # storeId: The store identifier. 200 # type: The physical store attribute name to describe the type of 201 # the store. 202 ( 203 : String, 204 : String, 205 : String, 206 : Int, 207 : Int, 208 : String, 209 : String, 210 : String, 211 : ResponseFormat, 212 : SiteLevelStoreSearch, 213 : String, 214 : String!, 215 : String 216 ): StorelocatorStorelocator 253 217 # Gets store location information by specified coordinates. 218 # 219 # Equivalent to GET 220 # /store/{storeId}/storelocator/latitude/{latitude}/longitude/{longitude} 221 # 222 # Arguments 223 # beautyCenter: The physical store attribute name that describes 224 # whether the store is a beauty center. 225 # latitude: The latitude. 226 # longitude: The longitude. 227 # maxItems: The maximum number of stores to return. 228 # radius: The radius. 229 # radiusUOM: The radius unit of measure. 230 # responseFormat: The response format. Valid values are json and 231 # xml. If the request contains an input body, it must use the format specified in 232 # responseFormat. If the responseFormat is not specified, the accept HTTP header 233 # determines the format of the response. If the accept HTTP header is not 234 # specified then default response format is json. 235 # siteLevelStoreSearch: If it is 'true', a site level physical 236 # search is performed. Otherwise, the physical store search is performed at the 237 # web store level. By default, it is 'true'. 238 # storeId: The store identifier. 239 # type: The physical store attribute name to describe the type of 240 # the store. 241 ( 242 : String, 243 : String!, 244 : String!, 245 : String, 246 : String, 247 : String, 248 : ResponseFormat, 249 : SiteLevelStoreSearch, 250 : String!, 251 : String 252 ): StorelocatorStorelocator 254 255 }
link Required by
This element is not required by anyone