OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Provides suggestions with type-ahead for search result page. 4 # 5 # Equivalent to GET /store/{storeId}/sitecontent/brandSuggestions 6 # 7 # Arguments 8 # catalogId: [Not documented] 9 # contractId: [Not documented] 10 # langId: [Not documented] 11 # limit: [Not documented] 12 # profileName: [Not documented] 13 # storeId: [Not documented] 14 # termsSort: [Not documented] 15 ( 16 : String, 17 : String, 18 : String, 19 : Int, 20 : String, 21 : String!, 22 : Boolean 23 ): CategorySuggestion 744 24 # Gets category details based on a list of unique IDs assigned to the categories 25 # by the database. 26 # 27 # Equivalent to GET /store/{storeId}/categoryview/byIds 28 # 29 # Arguments 30 # catalogId: [Not documented] 31 # checkEntitlement: [Not documented] 32 # contractId: [Not documented] 33 # currency: [Not documented] 34 # id: [Not documented] 35 # langId: [Not documented] 36 # orderBy: [Not documented] 37 # profileName: [Not documented] 38 # storeId: [Not documented] 39 ( 40 : String, 41 : Boolean, 42 : String, 43 : String, 44 : [String]!, 45 : String, 46 : String, 47 : String, 48 : String! 49 ): CatalogGroupDetailArray 744 50 # Gets category details based on its identifier (not the ID assigned by the 51 # database). 52 # 53 # Equivalent to GET /store/{storeId}/categoryview/{categoryIdentifier} 54 # 55 # Arguments 56 # catalogId: [Not documented] 57 # categoryIdentifier: [Not documented] 58 # checkEntitlement: [Not documented] 59 # contractId: [Not documented] 60 # currency: [Not documented] 61 # langId: [Not documented] 62 # profileName: [Not documented] 63 # storeId: [Not documented] 64 ( 65 : String, 66 : String!, 67 : Boolean, 68 : String, 69 : String, 70 : String, 71 : String, 72 : String! 73 ): CatalogGroupDetailArray 744 74 # Gets category details based on category identifiers specified (not the id 75 # assigned by the database). 76 # 77 # Equivalent to GET /store/{storeId}/categoryview/byIdentifiers 78 # 79 # Arguments 80 # catalogId: [Not documented] 81 # checkEntitlement: [Not documented] 82 # contractId: [Not documented] 83 # currency: [Not documented] 84 # identifier: [Not documented] 85 # langId: [Not documented] 86 # orderBy: [Not documented] 87 # storeId: [Not documented] 88 ( 89 : String, 90 : Boolean, 91 : String, 92 : String, 93 : [String], 94 : String, 95 : String, 96 : String! 97 ): CatalogGroupDetailArray 744 98 # Gets category details based on the unique ID assigned to the category by the 99 # database. 100 # 101 # Equivalent to GET /store/{storeId}/categoryview/byId/{categoryId} 102 # 103 # Arguments 104 # catalogId: [Not documented] 105 # categoryId: [Not documented] 106 # checkEntitlement: [Not documented] 107 # contractId: [Not documented] 108 # currency: [Not documented] 109 # langId: [Not documented] 110 # profileName: [Not documented] 111 # storeId: [Not documented] 112 ( 113 : String, 114 : String!, 115 : Boolean, 116 : String, 117 : String, 118 : String, 119 : String, 120 : String! 121 ): CatalogGroupDetailArray 744 122 # Provides suggestions with type-ahead for search result page. 123 # 124 # Equivalent to GET /store/{storeId}/sitecontent/categorySuggestions 125 # 126 # Arguments 127 # catalogId: [Not documented] 128 # contractId: [Not documented] 129 # count: [Not documented] 130 # langId: [Not documented] 131 # limit: [Not documented] 132 # profileName: [Not documented] 133 # storeId: [Not documented] 134 # termsSort: [Not documented] 135 ( 136 : String, 137 : String, 138 : Int, 139 : String, 140 : Int, 141 : String, 142 : String!, 143 : Boolean 144 ): CategorySuggestion 744 145 # Provides keyword suggestions with type-ahead for search result page based on a 146 # term. 147 # 148 # Equivalent to GET /store/{storeId}/sitecontent/keywordSuggestionsByTerm/{term} 149 # 150 # Arguments 151 # catalogId: [Not documented] 152 # contractId: [Not documented] 153 # langId: [Not documented] 154 # limit: [Not documented] 155 # profileName: [Not documented] 156 # storeId: [Not documented] 157 # term: [Not documented] 158 # termsSort: [Not documented] 159 ( 160 : String, 161 : String, 162 : String, 163 : String, 164 : String, 165 : String!, 166 : String!, 167 : Boolean 168 ): KeywordSuggestion 744 169 # Gets products by part number. 170 # 171 # Equivalent to GET /store/{storeId}/productview/byPartNumber/{partNumber} 172 # 173 # Arguments 174 # associationType: [Not documented] 175 # attachmentFilter: [Not documented] 176 # attributeKeyword: [Not documented] 177 # catalogId: [Not documented] 178 # checkEntitlement: [Not documented] 179 # contractId: [Not documented] 180 # currency: [Not documented] 181 # langId: [Not documented] 182 # partNumber: [Not documented] 183 # profileName: [Not documented] 184 # storeId: [Not documented] 185 ( 186 : String, 187 : String, 188 : String, 189 : String, 190 : Boolean, 191 : String, 192 : String, 193 : String, 194 : String!, 195 : String, 196 : String! 197 ): ProductDetail 744 198 # Gets product details based on the product ID. 199 # 200 # Equivalent to GET /store/{storeId}/productview/byId/{productId} 201 # 202 # Arguments 203 # associationType: [Not documented] 204 # attachmentFilter: [Not documented] 205 # attributeKeyword: [Not documented] 206 # catalogId: [Not documented] 207 # checkEntitlement: [Not documented] 208 # contractId: [Not documented] 209 # currency: [Not documented] 210 # langId: [Not documented] 211 # productId: [Not documented] 212 # profileName: [Not documented] 213 # storeId: [Not documented] 214 ( 215 : String, 216 : String, 217 : String, 218 : String, 219 : Boolean, 220 : String, 221 : String, 222 : String, 223 : String!, 224 : String, 225 : String! 226 ): ProductDetail 744 227 # Gets products by part number. 228 # 229 # Equivalent to GET /store/{storeId}/productview/{partNumber} 230 # 231 # Arguments 232 # associationType: [Not documented] 233 # attachmentFilter: [Not documented] 234 # attributeKeyword: [Not documented] 235 # catalogId: [Not documented] 236 # checkEntitlement: [Not documented] 237 # contractId: [Not documented] 238 # currency: [Not documented] 239 # langId: [Not documented] 240 # partNumber: [Not documented] 241 # profileName: [Not documented] 242 # storeId: [Not documented] 243 ( 244 : String, 245 : String, 246 : String, 247 : String, 248 : Boolean, 249 : String, 250 : String, 251 : String, 252 : String!, 253 : String, 254 : String! 255 ): ProductDetail 744 256 # Gets products by part numbers. 257 # 258 # Equivalent to GET /store/{storeId}/productview/byPartNumbers 259 # 260 # Arguments 261 # associationType: [Not documented] 262 # attachmentFilter: [Not documented] 263 # catalogId: [Not documented] 264 # checkEntitlement: [Not documented] 265 # contractId: [Not documented] 266 # currency: [Not documented] 267 # langId: [Not documented] 268 # partNumber: [Not documented] 269 # profileName: [Not documented] 270 # storeId: [Not documented] 271 ( 272 : String, 273 : String, 274 : String, 275 : Boolean, 276 : String, 277 : String, 278 : String, 279 : [String]!, 280 : String, 281 : String! 282 ): ProductDetailArray 744 283 # Provides suggestions with type-ahead for search result page. 284 # 285 # Equivalent to GET 286 # /store/{storeId}/sitecontent/productSuggestionsBySearchTerm/{searchTerm} 287 # 288 # Arguments 289 # catalogId: [Not documented] 290 # checkEntitlement: [Not documented] 291 # contractId: [Not documented] 292 # langId: [Not documented] 293 # pageNumber: [Not documented] 294 # pageSize: [Not documented] 295 # profileName: [Not documented] 296 # searchTerm: [Not documented] 297 # searchType: [Not documented] 298 # storeId: [Not documented] 299 # term: [Not documented] 300 # termsSort: [Not documented] 301 ( 302 : String, 303 : Boolean, 304 : String, 305 : String, 306 : Int, 307 : Int, 308 : String, 309 : String!, 310 : Int, 311 : String!, 312 : Boolean, 313 : Boolean 314 ): ProductSuggestion 744 315 # Gets Products 316 # 317 # Equivalent to GET /api/v2/products 318 # 319 # Arguments 320 # associationType: [Not documented] 321 # attachmentFilter: [Not documented] 322 # attributeKeyword: [Not documented] 323 # catalogId: [Not documented] 324 # categoryId: [Not documented] 325 # checkEntitlement: [Not documented] 326 # contractId: [Not documented] 327 # currency: [Not documented] 328 # disableSearchRules: [Not documented] 329 # id: [Not documented] 330 # langId: [Not documented] 331 # limit: [Not documented] 332 # offset: [Not documented] 333 # partNumber: [Not documented] 334 # productId: [Not documented] 335 # profileName: [Not documented] 336 # searchTerm: [Not documented] 337 # searchType: [Not documented] 338 # storeId: [Not documented] 339 ( 340 : String, 341 : String, 342 : String, 343 : String, 344 : String, 345 : Boolean, 346 : String, 347 : String, 348 : Boolean, 349 : [String], 350 : String, 351 : Int, 352 : Int, 353 : [String], 354 : String, 355 : String, 356 : String, 357 : Int, 358 : String! 359 ): ProductDetail 744 360 # Finds a product by its ID. 361 # 362 # Equivalent to GET /store/{storeId}/productview/byCategory/{categoryId} 363 # 364 # Arguments 365 # advancedFacetList: [Not documented] 366 # associationType: [Not documented] 367 # attachmentFilter: [Not documented] 368 # attributeKeyword: [Not documented] 369 # catalogId: [Not documented] 370 # categoryId: [Not documented] 371 # checkEntitlement: [Not documented] 372 # contractId: [Not documented] 373 # currency: [Not documented] 374 # facet: [Not documented] 375 # facetLimit: [Not documented] 376 # filterFacet: [Not documented] 377 # filterTerm: [Not documented] 378 # langId: [Not documented] 379 # manufacturer: [Not documented] 380 # maxPrice: [Not documented] 381 # minPrice: [Not documented] 382 # orderBy: [Not documented] 383 # pageNumber: [Not documented] 384 # pageSize: [Not documented] 385 # profileName: [Not documented] 386 # searchType: [Not documented] 387 # storeId: [Not documented] 388 ( 389 : String, 390 : String, 391 : String, 392 : String, 393 : String, 394 : String!, 395 : Boolean, 396 : String, 397 : String, 398 : Boolean, 399 : String, 400 : String, 401 : String, 402 : String, 403 : String, 404 : Int, 405 : Int, 406 : String, 407 : Int, 408 : Int, 409 : String, 410 : Int, 411 : String! 412 ): ProductSummaryArray 744 413 # By default, this API returns all products under the category and subcategories 414 # by deep search. It does not only return products in the current category. There 415 # is no control over the limit of each subcategory under the category facet. 416 # 417 # Equivalent to GET /store/{storeId}/productview/byCategoryForAdmin/{categoryId} 418 # 419 # Arguments 420 # advancedFacetList: [Not documented] 421 # associationType: [Not documented] 422 # attachmentFilter: [Not documented] 423 # attributeKeyword: [Not documented] 424 # catalogId: [Not documented] 425 # categoryId: [Not documented] 426 # checkEntitlement: [Not documented] 427 # contractId: [Not documented] 428 # currency: [Not documented] 429 # debug: [Not documented] 430 # facet: [Not documented] 431 # facetLimit: [Not documented] 432 # filterFacet: [Not documented] 433 # filterTerm: [Not documented] 434 # langId: [Not documented] 435 # manufacturer: [Not documented] 436 # maxPrice: [Not documented] 437 # minPrice: [Not documented] 438 # orderBy: [Not documented] 439 # pageNumber: [Not documented] 440 # pageSize: [Not documented] 441 # profileName: [Not documented] 442 # searchType: [Not documented] 443 # storeId: [Not documented] 444 ( 445 : String, 446 : String, 447 : String, 448 : String, 449 : String, 450 : String!, 451 : String, 452 : String, 453 : String, 454 : String, 455 : String, 456 : String, 457 : String, 458 : String, 459 : String, 460 : String, 461 : String, 462 : String, 463 : String, 464 : String, 465 : String, 466 : String, 467 : String, 468 : String! 469 ): ProductSummaryArray 744 470 # Gets product details based on the product ID. 471 # 472 # Equivalent to GET /store/{storeId}/productview/byIds 473 # 474 # Arguments 475 # associationType: [Not documented] 476 # attachmentFilter: [Not documented] 477 # attributeKeyword: [Not documented] 478 # catalogId: [Not documented] 479 # checkEntitlement: [Not documented] 480 # contractId: [Not documented] 481 # currency: [Not documented] 482 # id: [Not documented] 483 # langId: [Not documented] 484 # profileName: [Not documented] 485 # storeId: [Not documented] 486 ( 487 : String, 488 : String, 489 : String, 490 : String, 491 : Boolean, 492 : String, 493 : String, 494 : [String]!, 495 : String, 496 : String, 497 : String! 498 ): ProductDetail 744 499 # Gets product details based on a search term. 500 # 501 # Equivalent to GET /store/{storeId}/productview/bySearchTerm/{searchTerm} 502 # 503 # Arguments 504 # advancedFacetList: [Not documented] 505 # associationType: [Not documented] 506 # attachmentFilter: [Not documented] 507 # attributeKeyword: [Not documented] 508 # catalogId: [Not documented] 509 # categoryId: [Not documented] 510 # checkEntitlement: [Not documented] 511 # contractId: [Not documented] 512 # currency: [Not documented] 513 # disableSearchRules: [Not documented] 514 # facet: [Not documented] 515 # facetLimit: [Not documented] 516 # filterFacet: [Not documented] 517 # filterTerm: [Not documented] 518 # langId: [Not documented] 519 # manufacturer: [Not documented] 520 # maxPrice: [Not documented] 521 # minPrice: [Not documented] 522 # orderBy: [Not documented] 523 # pageNumber: [Not documented] 524 # pageSize: [Not documented] 525 # physicalStoreIds: [Not documented] 526 # profileName: [Not documented] 527 # searchTerm: [Not documented] 528 # searchType: [Not documented] 529 # storeId: [Not documented] 530 ( 531 : String, 532 : String, 533 : String, 534 : String, 535 : String, 536 : String, 537 : Boolean, 538 : String, 539 : String, 540 : Boolean, 541 : Boolean, 542 : String, 543 : String, 544 : String, 545 : String, 546 : String, 547 : Int, 548 : Int, 549 : String, 550 : Int, 551 : Int, 552 : String, 553 : String, 554 : String!, 555 : Int, 556 : String! 557 ): ProductSummaryArray 744 558 # Gets child categories based on the unique Id assigned to the parent category by 559 # the database. 560 # 561 # Equivalent to GET 562 # /store/{storeId}/categoryview/byParentCategory/{parentCategoryId} 563 # 564 # Arguments 565 # catalogId: [Not documented] 566 # checkEntitlement: [Not documented] 567 # contractId: [Not documented] 568 # currency: [Not documented] 569 # depthAndLimit: [Not documented] 570 # langId: [Not documented] 571 # orderBy: [Not documented] 572 # pageNumber: [Not documented] 573 # pageSize: [Not documented] 574 # parentCategoryId: [Not documented] 575 # profileName: [Not documented] 576 # storeId: [Not documented] 577 ( 578 : String, 579 : Boolean, 580 : String, 581 : String, 582 : String, 583 : String, 584 : String, 585 : Int, 586 : Int, 587 : String!, 588 : String, 589 : String! 590 ): CatalogGroupDetailWithSequenceArray 744 591 # Provides suggestions with type-ahead for search result page. 592 # 593 # Equivalent to GET /store/{storeId}/sitecontent/suggestions 594 # 595 # Arguments 596 # catalogId: [Not documented] 597 # contractId: [Not documented] 598 # count: [Not documented] 599 # langId: [Not documented] 600 # limit: [Not documented] 601 # storeId: [Not documented] 602 # suggestType: [Not documented] 603 # term: [Not documented] 604 # termsSort: [Not documented] 605 ( 606 : String, 607 : String, 608 : Int, 609 : String, 610 : String, 611 : String!, 612 : String, 613 : String, 614 : Boolean 615 ): CommonSuggestions 744 616 # Gets all top level categories. 617 # 618 # Equivalent to GET /store/{storeId}/categoryview/@top 619 # 620 # Arguments 621 # catalogId: [Not documented] 622 # checkEntitlement: [Not documented] 623 # contractId: [Not documented] 624 # currency: [Not documented] 625 # depthAndLimit: [Not documented] 626 # langId: [Not documented] 627 # orderBy: [Not documented] 628 # pageNumber: [Not documented] 629 # pageSize: [Not documented] 630 # profileName: [Not documented] 631 # storeId: [Not documented] 632 ( 633 : String, 634 : Boolean, 635 : String, 636 : String, 637 : String, 638 : String, 639 : String, 640 : Int, 641 : Int, 642 : String, 643 : String! 644 ): CatalogGroupDetailWithSequenceArray 744 645 # Get the summary of all Ingest Connector Status 646 # 647 # Equivalent to GET /api/v2/data/status 648 # 649 # Arguments 650 # envType: [Not documented] 651 # storeId: [Not documented] 652 ( 653 : String, 654 : String 655 ): DataStatusEntry 744 656 # Get the Colors configuration data from ZooKeeper. 657 # 658 # Equivalent to GET /api/v2/configuration/colors 659 # 660 # Arguments 661 # envType: [Not documented] 662 # locale: [Not documented] 663 # storeId: [Not documented] 664 (: String!, : String!, : String!): JSON 744 665 # Get the configuration node data from ZooKeeper. 666 # 667 # Equivalent to GET /api/v2/configuration 668 # 669 # Arguments 670 # envType: [Not documented] 671 # locale: [Not documented] 672 # nodeName: [Not documented] 673 ( 674 : String!, 675 : String, 676 : String! 677 ): JSON 744 678 # Get the search profile. 679 # 680 # Equivalent to GET /api/v2/documents/profiles/{profileName} 681 # 682 # Arguments 683 # profileName: [Not documented] 684 # profileType: [Not documented] 685 (: String!, : ProfileType): [SearchProfile] 744 686 # Gets the search profiles. 687 # 688 # Equivalent to GET /api/v2/documents/profiles 689 # 690 # Arguments 691 # profileType: [Not documented] 692 (: ProfileType): [SearchProfile] 744 693 # Gets a search ranking by ID. 694 # 695 # Equivalent to GET /api/v2/rankings/{id} 696 # 697 # Arguments 698 # id: The ID created during the creation of search ranking 699 # languageId: The unique language identifier of the supported 700 # language 701 # storeId: The unique store identifier of the respective store 702 ( 703 : String!, 704 : Int!, 705 : Int! 706 ): SearchRanking 744 707 # Gets all of the search rankings. 708 # 709 # Equivalent to GET /api/v2/rankings 710 # 711 # Arguments 712 # languageId: The unique language identifier of the supported 713 # language 714 # storeId: The unique store identifier of the respective store 715 (: Int!, : Int!): SearchRankingNameCollection 744 716 # Gets Response for V2.0 API for store as per the requirements 717 # 718 # Equivalent to GET /api/v2/categories 719 # 720 # Arguments 721 # depthAndLimit: [Not documented] 722 # id: [Not documented] 723 # identifier: [Not documented] 724 # parentCategoryId: [Not documented] 725 # storeId: [Not documented] 726 ( 727 : [String], 728 : [String], 729 : [String], 730 : String, 731 : String! 732 ): String 744 733 # Gets Response for V2.0 API Seo url data 734 # 735 # Equivalent to GET /api/v2/urls 736 # 737 # Arguments 738 # identifier: [Not documented] 739 # storeId: [Not documented] 740 ( 741 : [String], 742 : Int! 743 ): SearchRankingNameCollection 745 746 }
link Required by
This element is not required by anyone