OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Gets category details based on its identifier (not the by the ID assigned by the 4 # database). 5 # 6 # Equivalent to GET /store/{storeId}/categoryview/{categoryIdentifier} 7 # 8 # Arguments 9 # catalogId: The catalog identifier. If none is specified, the 10 # store default catalog shall be used. 11 # categoryIdentifier: The category identifier that was 12 # configured, not the one assigned by the database. 13 # checkEntitlement: Option to force an entitlement check. 14 # contractId: The contractId 15 # currency: The currency code to use. Example usage : 16 # currency=USD. If no currency code is specified, the store default currency shall 17 # be used. 18 # fields: The fields to be returned by the response. 19 # langId: Language identifier. If not specified, then the store 20 # default language shall be used. 21 # storeId: The store ID. 22 ( 23 : String, 24 : String!, 25 : Boolean, 26 : String, 27 : String, 28 : String, 29 : String, 30 : String! 31 ): CategoryViewGetCategoryInformationBycategoryIdentifier 852 32 # Gets category details for multiple categories based on category identifiers 33 # specified (not the id assigned by the database). 34 # 35 # Equivalent to GET /store/{storeId}/categoryview/byIdentifiers 36 # 37 # Arguments 38 # catalogId: The catalog identifier. If none is specified, the 39 # store default catalog shall be used. 40 # checkEntitlement: Option to force an entitlement check. 41 # contractId: The contractId 42 # currency: The currency code to use. Example usage : 43 # currency=USD. If no currency code is specified, the store default currency shall 44 # be used. 45 # fields: The fields to be returned by the response. 46 # identifier: The list of category identifiers, not the ones 47 # assigned by the database. 48 # langId: Language identifier. If not specified, then the store 49 # default language shall be used. 50 # storeId: The store ID. 51 ( 52 : String, 53 : Boolean, 54 : String, 55 : String, 56 : String, 57 : [String]!, 58 : String, 59 : String! 60 ): CategoryViewGetCategoryInformationByIdentifier 852 61 # Gets category details based on the unique ID assigned by the database. 62 # 63 # Equivalent to GET /store/{storeId}/categoryview/byId/{categoryId} 64 # 65 # Arguments 66 # catalogId: The catalog identifier. If none is specified, the 67 # store default catalog shall be used. 68 # categoryId: The category identifier that was assigned by the 69 # database. 70 # checkEntitlement: Option to force an entitlement check. 71 # contractId: The contractId 72 # currency: The currency code to use. Example usage : 73 # currency=USD. If no currency code is specified, the store default currency shall 74 # be used. 75 # fields: The fields to be returned by the response. 76 # langId: Language identifier. If not specified, then the store 77 # default language shall be used. 78 # storeId: The store ID. 79 ( 80 : String, 81 : String!, 82 : Boolean, 83 : String, 84 : String, 85 : String, 86 : String, 87 : String! 88 ): CategoryViewGetCategoryInformationBycategoryId 852 89 # Gets category details based on the unique ID. 90 # 91 # Equivalent to GET /store/{storeId}/categoryview/byIds 92 # 93 # Arguments 94 # catalogId: The catalog identifier. If none is specified, the 95 # store default catalog shall be used. 96 # checkEntitlement: Option to force an entitlement check. 97 # contractId: The contractId 98 # currency: The currency code to use. Example usage : 99 # currency=USD. If no currency code is specified, the store default currency shall 100 # be used. 101 # fields: The fields to be returned by the response. 102 # id: The list of category identifiers. 103 # langId: Language identifier. If not specified, then the store 104 # default language shall be used. 105 # orderBy: The field name to use when ordering the results. 106 # storeId: The store ID. 107 ( 108 : String, 109 : Boolean, 110 : String, 111 : String, 112 : String, 113 : [String]!, 114 : String, 115 : String, 116 : String! 117 ): CategoryViewGetCategoryInformationById 852 118 # Gets child categories based on the parent category unique ID. 119 # 120 # Equivalent to GET 121 # /store/{storeId}/categoryview/byParentCategory/{parentCategoryId} 122 # 123 # Arguments 124 # catalogId: The catalog identifier. If none is specified, the 125 # store default catalog shall be used. 126 # checkEntitlement: Option to force an entitlement check. 127 # contractId: The contractId 128 # currency: The currency code to use. Example usage : 129 # currency=USD. If no currency code is specified, the store default currency shall 130 # be used. 131 # depthAndLimit: The comma separated list of numbers is to 132 # control the depth of sub-categories and limit the number of items returned under 133 # each child category level. The first number in this list determines the maximum 134 # of categories (first level sub-categories) to be returned under the immediate 135 # child category. The second number in the list determines the maximum number of 136 # categories to be returned under the first level sub-categories. A value of "-1" 137 # implies no limit. In that case, only the first level categories will be 138 # returned. For example, "pageSize=4&limitSubCategories=-1,3,0,1" implies that 139 # there will be unlimited first level sub-categories under the immediate child 140 # categories. Under these categories (up to 4), all sub-categories will be 141 # returned and a maximum of 3 second level sub-categories will be returned. There 142 # will be no third level or fourth level since the third level limit is 0. Any 143 # level after a limit of 0 will be ignored. By default, no sub-category will be 144 # returned if this parameter is not specified. When the asterisk "*" is specified, 145 # it is considered the same as "-1" but, any subsequent levels will also be 146 # treated "-1". 147 # fields: The fields to be returned by the response. 148 # langId: Language identifier. If not specified, then the store 149 # default language shall be used. 150 # orderBy: The field name to use when ordering the results. 151 # pageNumber: Page number, starting at 1. Valid values include 152 # positive integers of 1 and above. The "pageSize" must be specified for paging to 153 # work. 154 # pageSize: Page size. Used to limit the amount of data returned 155 # by a query. Valid values include positive integers of 1 and above. The 156 # "pageNumber" must be specified for paging to work. 157 # parentCategoryId: The parent category id. 158 # storeId: The store ID. 159 ( 160 : String, 161 : Boolean, 162 : String, 163 : String, 164 : String, 165 : String, 166 : String, 167 : String, 168 : String, 169 : String, 170 : String!, 171 : String! 172 ): CategoryViewGetCategoryInformationByParentcategoryId 852 173 # Gets all top level categories. 174 # 175 # Equivalent to GET /store/{storeId}/categoryview/@top 176 # 177 # Arguments 178 # catalogId: The catalog identifier. If none is specified, the 179 # store default catalog shall be used. 180 # checkEntitlement: Option to force an entitlement check. 181 # contractId: The contractId 182 # currency: The currency code to use. Example usage : 183 # currency=USD. If no currency code is specified, the store default currency shall 184 # be used. 185 # depthAndLimit: The comma separated list of numbers is to 186 # control the depth of sub-categories and limit the number of items returned under 187 # each child category level. The first number in this list determines the maximum 188 # of categories (first level sub-categories) to be returned under the immediate 189 # child category. The second number in the list determines the maximum number of 190 # categories to be returned under the first level sub-categories. A value of "-1" 191 # implies no limit. In that case, only the first level categories will be 192 # returned. For example, "pageSize=4&limitSubCategories=-1,3,0,1" implies that 193 # there will be unlimited first level sub-categories under the immediate child 194 # categories. Under these categories (up to 4), all sub-categories will be 195 # returned and a maximum of 3 second level sub-categories will be returned. There 196 # will be no third level or fourth level since the third level limit is 0. Any 197 # level after a limit of 0 will be ignored. By default, no sub-category will be 198 # returned if this parameter is not specified. When the asterisk "*" is specified, 199 # it is considered the same as "-1" but, any subsequent levels will also be 200 # treated "-1". 201 # fields: The fields to be returned by the response. 202 # langId: Language identifier. If not specified, then the store 203 # default language shall be used. 204 # orderBy: The field name to use when ordering the results. 205 # pageNumber: Page number, starting at 1. Valid values include 206 # positive integers of 1 and above. The "pageSize" must be specified for paging to 207 # work. 208 # pageSize: Page size. Used to limit the amount of data returned 209 # by a query. Valid values include positive integers of 1 and above. The 210 # "pageNumber" must be specified for paging to work. 211 # storeId: The store ID. 212 ( 213 : String, 214 : Boolean, 215 : String, 216 : String, 217 : String, 218 : String, 219 : String, 220 : String, 221 : String, 222 : String, 223 : String! 224 ): CategoryViewGetCategoryInformationOnTop 852 225 # Gets product details based on the product ID. 226 # 227 # Equivalent to GET /store/{storeId}/productview/byId/{productId} 228 # 229 # Arguments 230 # associationType: The type of the merchandising association to 231 # be returned. 232 # attachementFilter: The attachment filter. 233 # attributeKeyword: The attribute associated keywords to be 234 # returned. 235 # catalogId: The catalog identifier. If none is specified, the 236 # store default catalog shall be used. 237 # checkEntitlement: Option to force an entitlement check. 238 # contractId: The contractId 239 # currency: The currency code to use. Example usage : 240 # currency=USD. If no currency code is specified, the store default currency shall 241 # be used. 242 # fields: The fields to be returned by the response. 243 # invVisibilityMode: The inventory visibility mode that controls 244 # how the inventory index is processed. For example, given a value of 1, the index 245 # ignores inventory filters that have been set in the server. A value of 2 returns 246 # inventory statuses in the response. A value of 3 (the sum of the different 247 # modes) applies all contributed modes 248 # langId: Language identifier. If not specified, then the store 249 # default language shall be used. 250 # productId: The product identifier. 251 # storeId: The store ID. 252 ( 253 : String, 254 : String, 255 : String, 256 : String, 257 : Boolean, 258 : String, 259 : String, 260 : String, 261 : String, 262 : String, 263 : String!, 264 : String! 265 ): ProductViewGetProductByProductId 852 266 # Gets products by part number. 267 # 268 # Equivalent to GET /store/{storeId}/productview/{partNumber} 269 # 270 # Arguments 271 # associationType: The type of the merchandising association to 272 # be returned. 273 # attachementFilter: The attachment filter. 274 # attributeKeyword: The attribute associated keywords to be 275 # returned. 276 # catalogId: The catalog identifier. If none is specified, the 277 # store default catalog shall be used. 278 # checkEntitlement: Option to force an entitlement check. 279 # contractId: The contractId 280 # currency: The currency code to use. Example usage : 281 # currency=USD. If no currency code is specified, the store default currency shall 282 # be used. 283 # fields: The fields to be returned by the response. 284 # invVisibilityMode: The inventory visibility mode that controls 285 # how the inventory index is processed. For example, given a value of 1, the index 286 # ignores inventory filters that have been set in the server. A value of 2 returns 287 # inventory statuses in the response. A value of 3 (the sum of the different 288 # modes) applies all contributed modes 289 # langId: Language identifier. If not specified, then the store 290 # default language shall be used. 291 # partNumber: The product part number. 292 # storeId: The store ID. 293 ( 294 : String, 295 : String, 296 : String, 297 : String, 298 : Boolean, 299 : String, 300 : String, 301 : String, 302 : String, 303 : String, 304 : String!, 305 : String! 306 ): ProductViewGetProductByPartNumber 852 307 # Gets products by part numbers. 308 # 309 # Equivalent to GET /store/{storeId}/productview/byPartNumbers 310 # 311 # Arguments 312 # associationType: The type of the merchandising association to 313 # be returned. 314 # attachementFilter: The attachment filter. 315 # catalogId: The catalog identifier. If none is specified, the 316 # store default catalog shall be used. 317 # checkEntitlement: Option to force an entitlement check. 318 # contractId: The contractId 319 # currency: The currency code to use. Example usage : 320 # currency=USD. If no currency code is specified, the store default currency shall 321 # be used. 322 # fields: The fields to be returned by the response. 323 # invVisibilityMode: The inventory visibility mode that controls 324 # how the inventory index is processed. For example, given a value of 1, the index 325 # ignores inventory filters that have been set in the server. A value of 2 returns 326 # inventory statuses in the response. A value of 3 (the sum of the different 327 # modes) applies all contributed modes 328 # langId: Language identifier. If not specified, then the store 329 # default language shall be used. 330 # partNumber: The product part numbers. 331 # storeId: The store ID. 332 ( 333 : String, 334 : String, 335 : String, 336 : Boolean, 337 : String, 338 : String, 339 : String, 340 : String, 341 : String, 342 : [String]!, 343 : String! 344 ): ProductViewGetProductByPartNumber 852 345 # Gets all products under the category and subcategories by deep search. It does 346 # not only return products in the current category. 347 # 348 # Equivalent to GET /store/{storeId}/productview/byCategory/{categoryId} 349 # 350 # Arguments 351 # advancedFacetList: The advanced facet list. 352 # associationType: The type of the merchandising association to 353 # be returned. 354 # attachementFilter: The attachment filter. 355 # attributeKeyword: The attribute associated keywords to be 356 # returned. 357 # catalogId: The catalog identifier. If none is specified, the 358 # store default catalog shall be used. 359 # categoryId: The category identifier. 360 # checkEntitlement: Option to force an entitlement check. 361 # contractId: The contractId 362 # currency: The currency code to use. Example usage : 363 # currency=USD. If no currency code is specified, the store default currency shall 364 # be used. 365 # facet: The selected facets. 366 # facetLimit: The multiple name-value pairs of facet limit 367 # defining the maximum number of items to be returned under each facet. The 368 # sequence of limits honored alongside with the sequence of facet name-value 369 # pairs. 370 # fields: The fields to be returned by the response. 371 # filterFacet: The filter facet. 372 # filterTerm: The filter term. 373 # langId: Language identifier. If not specified, then the store 374 # default language shall be used. 375 # manufacturer: The manufacturer name. 376 # maxPrice: The maximum price. Based on the selected currency.mc 377 # minPrice: The minimum price. Based on the selected currency. 378 # orderBy: The field name to use when ordering the results. 379 # pageNumber: Page number, starting at 1. Valid values include 380 # positive integers of 1 and above. The "pageSize" must be specified for paging to 381 # work. 382 # pageSize: Page size. Used to limit the amount of data returned 383 # by a query. Valid values include positive integers of 1 and above. The 384 # "pageNumber" must be specified for paging to work. 385 # priceMode: The price mode. 386 # searchSource: The search source. The default is "N" for shallow 387 # search navigation. All other values will result in expanded search in 388 # sub-categories. 389 # storeId: The store ID. 390 ( 391 : String, 392 : String, 393 : String, 394 : String, 395 : String, 396 : String!, 397 : Boolean, 398 : String, 399 : String, 400 : String, 401 : String, 402 : String, 403 : String, 404 : String, 405 : String, 406 : String, 407 : String, 408 : String, 409 : String, 410 : String, 411 : String, 412 : String, 413 : String, 414 : String! 415 ): ProductViewGetProductByCategoryID 852 416 # Gets all products under the category and subcategories by deep search. It does 417 # not only return products in the current category. The search is performed as an 418 # administrative user. 419 # 420 # Equivalent to GET /store/{storeId}/productview/byCategoryForAdmin/{categoryId} 421 # 422 # Arguments 423 # advancedFacetList: The advanced facet list. 424 # associationType: The type of the merchandising association to 425 # be returned. 426 # attachementFilter: The attachment filter. 427 # attributeKeyword: The attribute associated keywords to be 428 # returned. 429 # catalogId: The catalog identifier. If none is specified, the 430 # store default catalog shall be used. 431 # categoryId: The category identifier. 432 # checkEntitlement: Option to force an entitlement check. 433 # contractId: The contractId 434 # currency: The currency code to use. Example usage : 435 # currency=USD. If no currency code is specified, the store default currency shall 436 # be used. 437 # debug: Used to display debug info. Set to 'true' to display 438 # sequence score. 439 # excludeIds: The list of product to be excluded from the search 440 # results , this is comma separated productId 441 # facet: The selected facets. 442 # facetLimit: The multiple name-value pairs of facet limit 443 # defining the maximum number of items to be returned under each facet. The 444 # sequence of limits honored alongside with the sequence of facet name-value 445 # pairs. 446 # fields: The fields to be returned by the response. 447 # filterFacet: The filter facet. 448 # filterTerm: The filter term. 449 # langId: Language identifier. If not specified, then the store 450 # default language shall be used. 451 # manufacturer: The manufacturer name. 452 # maxPrice: The maximum price. Based on the selected currency.mc 453 # minPrice: The minimum price. Based on the selected currency. 454 # orderBy: The field name to use when ordering the results. 455 # pageNumber: Page number, starting at 1. Valid values include 456 # positive integers of 1 and above. The "pageSize" must be specified for paging to 457 # work. 458 # pageSize: Page size. Used to limit the amount of data returned 459 # by a query. Valid values include positive integers of 1 and above. The 460 # "pageNumber" must be specified for paging to work. 461 # priceMode: The price mode. 462 # searchSource: The search source. The default is "N" for shallow 463 # search navigation. All other values will result in expanded search in 464 # sub-categories. 465 # sequenceRule: The dynamic sequencing formula to be applied on 466 # the search results, 467 # storeId: The store ID. 468 ( 469 : String, 470 : String, 471 : String, 472 : String, 473 : String, 474 : String!, 475 : String, 476 : String, 477 : String, 478 : String, 479 : String, 480 : String, 481 : String, 482 : String, 483 : String, 484 : String, 485 : String, 486 : String, 487 : String, 488 : String, 489 : String, 490 : String, 491 : String, 492 : String, 493 : String, 494 : String, 495 : String! 496 ): ProductViewGetProductByCategoryID 852 497 # Gets product details based on the product ID. 498 # 499 # Equivalent to GET /store/{storeId}/productview/byIds 500 # 501 # Arguments 502 # associationType: The type of the merchandising association to 503 # be returned. 504 # attachementFilter: The attachment filter. 505 # attributeKeyword: The attribute associated keywords to be 506 # returned. 507 # catalogId: The catalog identifier. If none is specified, the 508 # store default catalog shall be used. 509 # checkEntitlement: Option to force an entitlement check. 510 # contractId: The contractId 511 # currency: The currency code to use. Example usage : 512 # currency=USD. If no currency code is specified, the store default currency shall 513 # be used. 514 # fields: The fields to be returned by the response. 515 # id: The product identifiers. 516 # invVisibilityMode: The inventory visibility mode that controls 517 # how the inventory index is processed. For example, given a value of 1, the index 518 # ignores inventory filters that have been set in the server. A value of 2 returns 519 # inventory statuses in the response. A value of 3 (the sum of the different 520 # modes) applies all contributed modes 521 # langId: Language identifier. If not specified, then the store 522 # default language shall be used. 523 # storeId: The store ID. 524 ( 525 : String, 526 : String, 527 : String, 528 : String, 529 : Boolean, 530 : String, 531 : String, 532 : String, 533 : [String]!, 534 : String, 535 : String, 536 : String! 537 ): ProductViewGetProductDetailsByID 852 538 # Gets product details based on a search term. 539 # 540 # Equivalent to GET /store/{storeId}/productview/bySearchTerm/{searchTerm} 541 # 542 # Arguments 543 # advancedFacetList: The advanced facet list. 544 # associationType: The type of the merchandising association to 545 # be returned. 546 # attachementFilter: The attachment filter. 547 # attributeKeyword: The attribute associated keywords to be 548 # returned. 549 # catalogId: The catalog identifier. If none is specified, the 550 # store default catalog shall be used. 551 # categoryId: The category identifier. 552 # checkEntitlement: Option to force an entitlement check. 553 # contractId: The contractId 554 # currency: The currency code to use. Example usage : 555 # currency=USD. If no currency code is specified, the store default currency shall 556 # be used. 557 # facet: The selected facets. 558 # facetLimit: The multiple name-value pairs of facet limit 559 # defining the maximum number of items to be returned under each facet. The 560 # sequence of limits honored alongside with the sequence of facet name-value 561 # pairs. 562 # fields: The fields to be returned by the response. 563 # filterFacet: The filter facet. 564 # filterTerm: The filter term. 565 # filterType: Used for advanced search option. 0 - search for any 566 # match, 1 - search for exact match, 2 - search for all matches 567 # intentSearchTerm: The value of the parameter is the term that 568 # the user intends to search. Characters are not escaped for the search engine. 569 # langId: Language identifier. If not specified, then the store 570 # default language shall be used. 571 # manufacturer: The manufacturer name. 572 # maxPrice: The maximum price. Based on the selected currency.mc 573 # minPrice: The minimum price. Based on the selected currency. 574 # orderBy: The field name to use when ordering the results. 575 # originalSearchTerm: The value of the parameter is the term that 576 # the user intends to search. Characters are escaped for the search engine. 577 # pageNumber: Page number, starting at 1. Valid values include 578 # positive integers of 1 and above. The "pageSize" must be specified for paging to 579 # work. 580 # pageSize: Page size. Used to limit the amount of data returned 581 # by a query. Valid values include positive integers of 1 and above. The 582 # "pageNumber" must be specified for paging to work. 583 # physicalStoreIds: The list of physical store identifiers. 584 # priceMode: The price mode. 585 # query: Query fields. Query fields determine the fields to be 586 # searched. Known valid values include: ManufacturerName, PartNumber, 587 # ManufacturerPartNumber, Name, ShortDescription, Keyword, CategoryPathName, and 588 # search-able attributes code. 589 # searchSource: The search source. The default is "N" for shallow 590 # search navigation. All other values will result in expanded search in 591 # sub-categories. 592 # searchTerm: The optional searchTerm parameter that will replace 593 # the {searchTerm} value in the context path parameter. It is used to avoid 594 # potential limitation of the special characters as being part of the context 595 # path. 596 # searchType: Search type is a numeric string that controls how 597 # multi-keyword search phrases are processed, for example that ANY term should 598 # match or ALL terms should match. Known valid values include: 10 (ANY) or 12 599 # (ALL), respectively. 600 # storeId: The store ID. 601 ( 602 : String, 603 : String, 604 : String, 605 : String, 606 : String, 607 : String, 608 : Boolean, 609 : String, 610 : String, 611 : String, 612 : String, 613 : String, 614 : String, 615 : String, 616 : String, 617 : String, 618 : String, 619 : String, 620 : String, 621 : String, 622 : String, 623 : String, 624 : String, 625 : String, 626 : String, 627 : String, 628 : String, 629 : String, 630 : String, 631 : String, 632 : String! 633 ): ProductViewGetProductBySearchTerm 852 634 # Provides brand suggestions with type-ahead for the search result page. 635 # 636 # Equivalent to GET /store/{storeId}/sitecontent/brandSuggestions 637 # 638 # Arguments 639 # catalogId: The catalog identifier. If none is specified, the 640 # store default catalog shall be used. 641 # contractId: The contractId 642 # count: The number of suggested keywords to be returned. The 643 # default value is 4. 644 # fields: The fields to be returned by the response. 645 # langId: Language identifier. If not specified, then the store 646 # default language shall be used. 647 # limit: Limit. 648 # storeId: The store ID. 649 # termsSort: The sorting to be used in the returned result, 650 # "count" or "index". By default, it is "count". 651 ( 652 : String, 653 : String, 654 : String, 655 : String, 656 : String, 657 : String, 658 : String!, 659 : Boolean 660 ): SearchSitecontentBrandSuggestions 852 661 # Provides category suggestions with type-ahead for search result page. 662 # 663 # Equivalent to GET /store/{storeId}/sitecontent/categorySuggestions 664 # 665 # Arguments 666 # catalogId: The catalog identifier. If none is specified, the 667 # store default catalog shall be used. 668 # contractId: The contractId 669 # count: The number of suggested keywords to be returned. The 670 # default value is 4. 671 # fields: The fields to be returned by the response. 672 # langId: Language identifier. If not specified, then the store 673 # default language shall be used. 674 # limit: Limit. 675 # storeId: The store ID. 676 # termsSort: The sorting to be used in the returned result, 677 # "count" or "index". By default, it is "count". 678 ( 679 : String, 680 : String, 681 : String, 682 : String, 683 : String, 684 : String, 685 : String!, 686 : Boolean 687 ): SearchSitecontentCategorysuggestions 852 688 # Provides keyword suggestions with type-ahead for search result page based on a 689 # term. 690 # 691 # Equivalent to GET /store/{storeId}/sitecontent/keywordSuggestionsByTerm/{term} 692 # 693 # Arguments 694 # catalogId: The catalog identifier. If none is specified, the 695 # store default catalog shall be used. 696 # contractId: The contractId 697 # count: The number of suggested keywords to be returned. The 698 # default value is 4. 699 # fields: The fields to be returned by the response. 700 # langId: Language identifier. If not specified, then the store 701 # default language shall be used. 702 # limit: Limit. 703 # storeId: The store ID. 704 # term: The search term. 705 # termsSort: The sorting to be used in the returned result, 706 # "count" or "index". By default, it is "count". 707 ( 708 : String, 709 : String, 710 : String, 711 : String, 712 : String, 713 : String, 714 : String!, 715 : String!, 716 : Boolean 717 ): SearchSitecontentKeywordSuggestionsByTermTerm 852 718 # Provides product suggestions with type-ahead for search result page. 719 # 720 # Equivalent to GET 721 # /store/{storeId}/sitecontent/productSuggestionsBySearchTerm/{searchTerm} 722 # 723 # Arguments 724 # catalogId: The catalog identifier. If none is specified, the 725 # store default catalog shall be used. 726 # checkEntitlement: Option to force an entitlement check. 727 # contractId: The contractId 728 # fields: The fields to be returned by the response. 729 # langId: Language identifier. If not specified, then the store 730 # default language shall be used. 731 # pageNumber: Page number, starting at 1. Valid values include 732 # positive integers of 1 and above. The "pageSize" must be specified for paging to 733 # work. 734 # pageSize: Page size. Used to limit the amount of data returned 735 # by a query. Valid values include positive integers of 1 and above. The 736 # "pageNumber" must be specified for paging to work. 737 # searchTerm: The term to search for. 738 # storeId: The store ID. 739 # term: The sorting to be used in the returned result, "count" or 740 # "index". By default, it is "count". 741 # termsSort: The sorting to be used in the returned result, 742 # "count" or "index". By default, it is "count". 743 ( 744 : String, 745 : Boolean, 746 : String, 747 : String, 748 : String, 749 : String, 750 : String, 751 : String!, 752 : String!, 753 : Boolean, 754 : Boolean 755 ): SearchSitecontentProductSuggestionsBySearchTermSearchterm 852 756 # Provides suggestions with type-ahead for search result page. 757 # 758 # Equivalent to GET /store/{storeId}/sitecontent/suggestions 759 # 760 # Arguments 761 # catalogId: The catalog identifier. If none is specified, the 762 # store default catalog shall be used. 763 # contractId: The contractId 764 # count: The number of suggested keywords to be returned. The 765 # default value is 4. 766 # fields: The fields to be returned by the response. 767 # langId: Language identifier. If not specified, then the store 768 # default language shall be used. 769 # limit: Limit. 770 # searchTerm: The search term. Not applicable for brand or 771 # category suggestions. 772 # storeId: The store ID. 773 # suggestType: The suggestion type. Accepted values are 774 # 'Category', 'Brand', 'Articles', 'Keyword', and 'Product'. 775 # termsSort: The sorting to be used in the returned result, 776 # "count" or "index". By default, it is "count". 777 ( 778 : String, 779 : String, 780 : String, 781 : String, 782 : String, 783 : String, 784 : String!, 785 : String!, 786 : String, 787 : Boolean 788 ): SearchSitecontentSuggestions 852 789 # Provides web content suggestions with type-ahead for the search result page. 790 # 791 # Equivalent to GET /store/{storeId}/sitecontent/webContentSuggestions 792 # 793 # Arguments 794 # catalogId: The catalog identifier. If none is specified, the 795 # store default catalog shall be used. 796 # count: The number of suggested keywords to be returned. The 797 # default value is 4. 798 # fields: The fields to be returned by the response. 799 # langId: Language identifier. If not specified, then the store 800 # default language shall be used. 801 # limit: Limit. 802 # storeId: The store ID. 803 # termsSort: The sorting to be used in the returned result, 804 # "count" or "index". By default, it is "count". 805 ( 806 : String, 807 : String, 808 : String, 809 : String, 810 : String, 811 : String!, 812 : Boolean 813 ): SearchSitecontentWebcontentsuggestions 852 814 # Searches unstructured content details for search result page based on a search 815 # term. 816 # 817 # Equivalent to GET 818 # /store/{storeId}/sitecontent/webContentsBySearchTerm/{searchTerm} 819 # 820 # Arguments 821 # catalogId: The catalog identifier. If none is specified, the 822 # store default catalog shall be used. 823 # facet: The selected facets. 824 # facetLimit: The multiple name-value pairs of facet limit 825 # defining the maximum number of items to be returned under each facet. The 826 # sequence of limits honored alongside with the sequence of facet name-value 827 # pairs. 828 # fields: The fields to be returned by the response. 829 # langId: Language identifier. If not specified, then the store 830 # default language shall be used. 831 # orderBy: The field name to use when ordering the results. 832 # pageNumber: Page number, starting at 1. Valid values include 833 # positive integers of 1 and above. The "pageSize" must be specified for paging to 834 # work. 835 # pageSize: Page size. Used to limit the amount of data returned 836 # by a query. Valid values include positive integers of 1 and above. The 837 # "pageNumber" must be specified for paging to work. 838 # searchTerm: The term to search for. 839 # storeId: The store ID. 840 ( 841 : String, 842 : String, 843 : String, 844 : String, 845 : String, 846 : String, 847 : String, 848 : String, 849 : String!, 850 : String! 851 ): SearchSitecontentWebcontentbysearchterm 853 854 }
link Required by
This element is not required by anyone