OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Gets inventory details for the specified product by its identifier (PartNumber). 4 # Multiple partNumbers can be passed to the URI separated by a comma (,). 5 # 6 # Equivalent to GET 7 # /store/{storeId}/inventoryavailability/byPartNumber/{partNumbers} 8 # 9 # Arguments 10 # forUser: User name to act on behalf of. 11 # forUserId: User identifier to act on behalf of. 12 # onlineStoreName: The online store name. 13 # partNumbers: The product identifiers. Multiple values are 14 # separated by commas for example, 15 # /inventoryavailability/'AuroraWMDRS-1,'AuroraWMDRS-2. 16 # physicalStoreName: The physical store names. Separate multiple 17 # values with a comma for example, physicalStoreName=China mall,Sales mall. 18 # responseFormat: The response format. Valid values are json and 19 # xml. If the request contains an input body, it must use the format specified in 20 # responseFormat. If the responseFormat is not specified, the accept HTTP header 21 # determines the format of the response. If the accept HTTP header is not 22 # specified then default response format is json. 23 # storeId: The store identifier. 24 ( 25 : String, 26 : String, 27 : String, 28 : String!, 29 : String, 30 : ResponseFormat, 31 : String! 32 ): InventoryavailabilityInventoryavailability 425 33 # Gets inventory details for the specified product by its catalog entry ID. 34 # Multiple product IDs can be passed to the URI separated by a comma (,). 35 # 36 # Equivalent to GET /store/{storeId}/inventoryavailability/{productIds} 37 # 38 # Arguments 39 # onlineStoreId: The online store identifier. 40 # physicalStoreId: The physical store identifiers. Multiple 41 # values are separated by commas. Example: physicalStoreId=10001,10002. 42 # productIds: The product identifiers. Multiple values are 43 # separated by commas. Example: /inventoryavailability/10001,10002. 44 # responseFormat: The response format. Valid values are json and 45 # xml. If the request contains an input body, it must use the format specified in 46 # responseFormat. If the responseFormat is not specified, the accept HTTP header 47 # determines the format of the response. If the accept HTTP header is not 48 # specified then default response format is json. 49 # storeId: The store identifier. 50 ( 51 : String, 52 : String, 53 : String!, 54 : ResponseFormat, 55 : String! 56 ): InventoryavailabilityInventoryavailability 425 57 # Gets inventory details for the specified order by it's identifier (order Id). 58 # 59 # Equivalent to GET /store/{storeId}/inventoryavailability/byOrderId/{orderId} 60 # 61 # Arguments 62 # onlineStoreId: The online store identifier. 63 # orderId: The order identifiers for example, 64 # /inventoryavailability/10001. 65 # physicalStoreId: The physical store identifiers. Check 66 # inventory availability in provided physical stores. Multiple values are 67 # separated by commas for example, physicalStoreId=10001,10002. 68 # responseFormat: The response format. Valid values are json and 69 # xml. If the request contains an input body, it must use the format specified in 70 # responseFormat. If the responseFormat is not specified, the accept HTTP header 71 # determines the format of the response. If the accept HTTP header is not 72 # specified then default response format is json. 73 # storeId: The store identifier. 74 ( 75 : String, 76 : String!, 77 : String!, 78 : ResponseFormat, 79 : String! 80 ): InventoryavailabilityInventoryavailabilityByorderid 425 81 # Gets a list of orders by buyer ID. 82 # 83 # Equivalent to GET /store/{storeId}/order/byBuyerId/{buyerId} 84 # 85 # Arguments 86 # buyerId: The store identifier. 87 # currency: The currency code to use for example, currency=USD. 88 # If no currency code is specified, the store default currency is used. 89 # pageNumber: Page number. Valid values are positive integers 90 # starting at 1. Use pageNumber with pageSize. 91 # pageSize: Page size. Used to limit the amount of data returned 92 # by a query. Valid values are integers starting with 1. Use pageSize with 93 # pageNumber. 94 # responseFormat: The response format. Valid values are json and 95 # xml. If the request contains an input body, it must use the format specified in 96 # responseFormat. If the responseFormat is not specified, the accept HTTP header 97 # determines the format of the response. If the accept HTTP header is not 98 # specified then default response format is json. 99 # storeId: The store identifier. 100 ( 101 : String!, 102 : String, 103 : Int, 104 : Int, 105 : ResponseFormat, 106 : String! 107 ): OrderOrderDetails 425 108 # Gets a list of orders by a merchant assigned order reference number (ORMOrder). 109 # 110 # Equivalent to GET /store/{storeId}/order/byORMOrder/{ORMOrder} 111 # 112 # Arguments 113 # oRMOrder: The store identifier. 114 # pageNumber: Page number. Valid values are positive integers 115 # starting at 1. Use pageNumber with pageSize. 116 # pageSize: Page size. Used to limit the amount of data returned 117 # by a query. Valid values are integers starting with 1. Use pageSize with 118 # pageNumber. 119 # responseFormat: The response format. Valid values are json and 120 # xml. If the request contains an input body, it must use the format specified in 121 # responseFormat. If the responseFormat is not specified, the accept HTTP header 122 # determines the format of the response. If the accept HTTP header is not 123 # specified then default response format is json. 124 # storeId: The store identifier. 125 ( 126 : String!, 127 : Int, 128 : Int, 129 : ResponseFormat, 130 : String! 131 ): OrderOrderSummary 425 132 # Gets the order details for a specific order ID. 133 # 134 # Equivalent to GET /store/{storeId}/order/{orderId} 135 # 136 # Arguments 137 # currency: The currency code to use for example, currency=USD. 138 # If no currency code is specified, the store default currency is used. 139 # orderId: The order identifier. 140 # pageNumber: Page number. Valid values are positive integers 141 # starting at 1. Use pageNumber with pageSize. 142 # pageSize: Page size. Used to limit the amount of data returned 143 # by a query. Valid values are integers starting with 1. Use pageSize with 144 # pageNumber. 145 # profileName: Profile name. Profiles determine the subset of 146 # data returned by a query. 147 # responseFormat: The response format. Valid values are json and 148 # xml. If the request contains an input body, it must use the format specified in 149 # responseFormat. If the responseFormat is not specified, the accept HTTP header 150 # determines the format of the response. If the accept HTTP header is not 151 # specified then default response format is json. 152 # storeId: The store identifier. 153 ( 154 : String, 155 : String!, 156 : Int, 157 : Int, 158 : ProfileName, 159 : ResponseFormat, 160 : String! 161 ): OrderOrderDetail 425 162 # Gets a list of orders by order status. 163 # 164 # Equivalent to GET /store/{storeId}/order/byStatus/{status} 165 # 166 # Arguments 167 # currency: The currency code to use for example, currency=USD. 168 # If no currency code is specified, the store default currency is used. 169 # orderType: The order type. 170 # pageNumber: Page number. Valid values are positive integers 171 # starting at 1. Use pageNumber with pageSize. 172 # pageSize: Page size. Used to limit the amount of data returned 173 # by a query. Valid values are integers starting with 1. Use pageSize with 174 # pageNumber. 175 # responseFormat: The response format. Valid values are json and 176 # xml. If the request contains an input body, it must use the format specified in 177 # responseFormat. If the responseFormat is not specified, the accept HTTP header 178 # determines the format of the response. If the accept HTTP header is not 179 # specified then default response format is json. 180 # status: The order status. 181 # storeId: The store identifier. 182 ( 183 : String, 184 : OrderType, 185 : Int, 186 : Int, 187 : ResponseFormat, 188 : String!, 189 : String! 190 ): OrderOrderSummary 425 191 # Gets order details for a specified external order ID. 192 # 193 # Equivalent to GET /store/{storeId}/order/oms_order/{extOrderId} 194 # 195 # Arguments 196 # extOrderId: The external order identifier. 197 # responseFormat: The response format. Valid values are json and 198 # xml. If the request contains an input body, it must use the format specified in 199 # responseFormat. If the responseFormat is not specified, the accept HTTP header 200 # determines the format of the response. If the accept HTTP header is not 201 # specified then default response format is json. 202 # storeId: The store identifier. 203 ( 204 : String!, 205 : ResponseFormat, 206 : String! 207 ): String 425 208 # Gets the order history for the authenticated user. 209 # 210 # Equivalent to GET /store/{storeId}/order/@history 211 # 212 # Arguments 213 # currency: The currency code to use for example, currency=USD. 214 # If no currency code is specified, the store default currency is used. 215 # pageNumber: Page number. Valid values are positive integers 216 # starting at 1. Use pageNumber with pageSize. 217 # pageSize: Page size. Used to limit the amount of data returned 218 # by a query. Valid values are integers starting with 1. Use pageSize with 219 # pageNumber. 220 # responseFormat: The response format. Valid values are json and 221 # xml. If the request contains an input body, it must use the format specified in 222 # responseFormat. If the responseFormat is not specified, the accept HTTP header 223 # determines the format of the response. If the accept HTTP header is not 224 # specified then default response format is json. 225 # storeId: The store identifier. 226 # userId: The user identifier. 227 ( 228 : String, 229 : Int, 230 : Int, 231 : ResponseFormat, 232 : String!, 233 : String 234 ): OrderOrderSummary 425 235 # Finds order comments for the specific order. 236 # 237 # Equivalent to GET /store/{storeId}/order/{orderId}/comment 238 # 239 # Arguments 240 # isAsc: Returned order comments sorted in ascending order. 241 # orderByField: The order by field name. 242 # orderId: The order identifier. 243 # pageNumber: Page number. Valid values are positive integers 244 # starting at 1. Use pageNumber with pageSize. 245 # pageSize: Page size. Used to limit the amount of data returned 246 # by a query. Valid values are integers starting with 1. Use pageSize with 247 # pageNumber. 248 # responseFormat: The response format. Valid values are json and 249 # xml. If the request contains an input body, it must use the format specified in 250 # responseFormat. If the responseFormat is not specified, the accept HTTP header 251 # determines the format of the response. If the accept HTTP header is not 252 # specified then default response format is json. 253 # storeId: The store identifier. 254 ( 255 : Boolean, 256 : String, 257 : String!, 258 : Int, 259 : Int, 260 : ResponseFormat, 261 : String! 262 ): orderCommentSummary 425 263 # Allows CSRs to find orders to work on behalf of a shopper. 264 # 265 # Equivalent to GET /store/{storeId}/order 266 # 267 # Arguments 268 # extOrderId: The external order identifier. 269 # maxResults: The maximum number of results to return. 270 # orderByFieldName: The order by field name. 271 # orderByTableName: The order by table name. 272 # orderId: The order Id. 273 # orderItemId: The order item identifier. 274 # pageNumber: Page number, starting at 1. Valid values include 275 # positive integers of 1 and above. The "pageSize" must be specified for paging to 276 # work. 277 # pageSize: Page size. Used to limit the amount of data returned 278 # by a query. Valid values include positive integers of 1 and above. The 279 # "pageNumber" must be specified for paging to work. 280 # profileName: Profile name. Profiles determine the subset of 281 # data returned by a query. The default profile name = IBM_Summary. 282 # q: The query name. 283 # recordSetTotal: The total number of records in set. 284 # retrievalOrderStatus: The order status to use for the retrieval 285 # of orders. 286 # retrievePendingGuestOrders: Whether to retrieve pending guest 287 # orders or to exclude them. When set to true, only pending orders placed by guest 288 # users will be returned. Default value is false. This parameter will be ignored 289 # when the 'status' parameter is set. 290 # startIndex: The starting index of the result. 291 # status: The order status. If 'status' is set, the 292 # 'retrievePendingGuestOrders' parameter will be ignored. 293 # storeId: The store identifier. 294 # userId: the user ID. 295 ( 296 : String, 297 : String, 298 : String, 299 : String, 300 : String!, 301 : String!, 302 : String, 303 : String, 304 : ProfileName2, 305 : Q!, 306 : String, 307 : String, 308 : RetrievePendingGuestOrders, 309 : String, 310 : String, 311 : String!, 312 : String 313 ): CSROrderSearchSummary 425 314 # Gets all of the shopper's wish lists. 315 # 316 # Equivalent to GET /store/{storeId}/wishlist/@self 317 # 318 # Arguments 319 # pageNumber: Page number. Valid values are positive integers 320 # starting at 1. Use pageNumber with pageSize. 321 # pageSize: Page size. Used to limit the amount of data returned 322 # by a query. Valid values are integers starting with 1. Use pageSize with 323 # pageNumber. 324 # responseFormat: The response format. Valid values are json and 325 # xml. If the request contains an input body, it must use the format specified in 326 # responseFormat. If the responseFormat is not specified, the accept HTTP header 327 # determines the format of the response. If the accept HTTP header is not 328 # specified then default response format is json. 329 # storeId: The store identifier. 330 ( 331 : Int, 332 : Int, 333 : ResponseFormat, 334 : String! 335 ): WishlistWishlist 425 336 # Gets the shopper's wish list by ExternalId or by ExternalId and GuestAccesskey. 337 # If only ExternalId is specified, the user must be authenticated. If ExternalId 338 # in not specified then it will be redirected to /store/{storeId}/wishlist and 339 # will give userId not defined. 340 # 341 # Equivalent to GET /store/{storeId}/wishlist/{externalId} 342 # 343 # Arguments 344 # externalId: Wish list external identifier. 345 # guestAccessKey: Wish list guest access key. 346 # responseFormat: The response format. Valid values are json and 347 # xml. If the request contains an input body, it must use the format specified in 348 # responseFormat. If the responseFormat is not specified, the accept HTTP header 349 # determines the format of the response. If the accept HTTP header is not 350 # specified then default response format is json. 351 # storeId: The store identifier. 352 ( 353 : String!, 354 : String, 355 : ResponseFormat, 356 : String! 357 ): WishlistWishlist 425 358 # Gets the shopper's default wish list. 359 # 360 # Equivalent to GET /store/{storeId}/wishlist/@default 361 # 362 # Arguments 363 # responseFormat: The response format. Valid values are json and 364 # xml. If the request contains an input body, it must use the format specified in 365 # responseFormat. If the responseFormat is not specified, the accept HTTP header 366 # determines the format of the response. If the accept HTTP header is not 367 # specified then default response format is json. 368 # storeId: The store identifier. 369 ( 370 : ResponseFormat, 371 : String! 372 ): WishlistWishlist 425 373 # Gets the shopper's wish list items by wish list ExternalId or by ExternalId and 374 # GuestAccesskey. If only ExternalId is specified, the user must be authenticated. 375 # 376 # Equivalent to GET /store/{storeId}/wishlist/{externalId}/item 377 # 378 # Arguments 379 # externalId: Wish list external identifier. 380 # guestAccessKey: Wish list guest access key. 381 # pageNumber: Page number. Valid values are positive integers 382 # starting at 1. Use pageNumber with pageSize. 383 # pageSize: Page size. Used to limit the amount of data returned 384 # by a query. Valid values are integers starting with 1. Use pageSize with 385 # pageNumber. 386 # responseFormat: The response format. Valid values are json and 387 # xml. If the request contains an input body, it must use the format specified in 388 # responseFormat. If the responseFormat is not specified, the accept HTTP header 389 # determines the format of the response. If the accept HTTP header is not 390 # specified then default response format is json. 391 # storeId: The store identifier. 392 ( 393 : String!, 394 : String, 395 : Int!, 396 : Int!, 397 : ResponseFormat, 398 : String! 399 ): WishlistWishlist 425 400 # Get the wishlists for a specific user. 401 # 402 # Equivalent to GET /store/{storeId}/wishlist 403 # 404 # Arguments 405 # pageNumber: Page number, starting at 1. Valid values include 406 # positive integers of 1 and above. The pageSize must be specified for paging to 407 # work. 408 # pageSize: Page size. Used to limit the amount of data returned 409 # by a query. Valid values include positive integers of 1 and above. The 410 # pageNumber must be specified for paging to work. 411 # responseFormat: The response format. Valid values are json and 412 # xml. If the request contains an input body, it must use the format specified in 413 # responseFormat. If the responseFormat is not specified, the accept HTTP header 414 # determines the format of the response. If the accept HTTP header is not 415 # specified then default response format is json. 416 # storeId: The store identifier. 417 # userId: The user ID. 418 ( 419 : Int, 420 : Int, 421 : ResponseFormat, 422 : String!, 423 : String! 424 ): WishlistWishlist 426 427 }
link Required by
This element is not required by anyone