WebSphere Commerce Service - Search Services
These services provide APIs related to searching either a B2B or B2C store. Use these classes to:
- Get top-level categories, child categories, category details by category ID, products, products by part number, products details by ID
- Provide brand, product, content and custom suggestions
- Search unstructured content by search term Schemes: https
Summary
Tag: Category View
This class provides RESTful services to get all top-level categories, get child categories, and to get category details by category id.
Operation Description GET /store/{storeId}/categoryview/byId/{categoryId} Get category details
GET /store/{storeId}/categoryview/@top Get all top categories
GET /store/{storeId}/categoryview/byParentCategory/{parentCategoryId} Get child categories
GET /store/{storeId}/categoryview/{categoryIdentifier} Get category details
GET /store/{storeId}/categoryview/byIds Get category details
Tag: Product View
This class provides RESTful services to get all products, get products by part number, get product details by id.
Operation Description GET /store/{storeId}/productview/byPartNumbers Get products by parts
GET /store/{storeId}/productview/byCategory/{categoryId} Get all products
GET /store/{storeId}/productview/byCategoryForAdmin/{categoryId} Get all products
GET /store/{storeId}/productview/byIds Get product details
GET /store/{storeId}/productview/bySearchTerm/{searchTerm} Get product details
GET /store/{storeId}/productview/byId/{productId} Get product details
GET /store/{storeId}/productview/{partNumber} Get products by part
Tag: Site Content
This class provides RESTful services to provide brand, product, content, and custom suggestions, and to search unstructured content by search term.
Operation Description GET /store/{storeId}/sitecontent/customSuggestions Provide custom suggestions
GET /store/{storeId}/sitecontent/brandSuggestions Provide brand suggestions
GET /store/{storeId}/sitecontent/productSuggestionsBySearchTerm/{searchTerm} Provide product suggestions
GET /store/{storeId}/sitecontent/keywordSuggestionsByTerm/{term} Provide keyword suggestions
GET /store/{storeId}/sitecontent/webContentSuggestions Provide content suggestion
GET /store/{storeId}/sitecontent/suggestions Provide suggestions
GET /store/{storeId}/sitecontent/webContentsBySearchTerm/{searchTerm} Search unstructured content
GET /store/{storeId}/sitecontent/categorySuggestions Provide category suggestions
Paths
Get all top categoriesGET /store/{storeId}/categoryview/@top
Tags: Category ViewGets all top level categories.
storeId The store ID.
path string depthAndLimit The comma separated list of numbers is to control the depth of sub-categories and limit the number of items returned under each child category level. The first number in this list determines the maximum of categories (first level sub-categories) to be returned under the immediate child category. The second number in the list determines the maximum number of categories to be returned under the first level sub-categories. A value of "-1" implies no limit. In that case, only the first level categories will be returned. For example, "pageSize=4&limitSubCategories=-1,3,0,1" implies that there will be unlimited first level sub-categories under the immediate child categories. Under these categories (up to 4), all sub-categories will be returned and a maximum of 3 second level sub-categories will be returned. There will be no third level or fourth level since the third level limit is 0. Any level after a limit of 0 will be ignored. By default, no sub-category will be returned if this parameter is not specified. When the asterisk "*" is specified, it is considered the same as "-1" but, any subsequent levels will also be treated "-1".
query string orderBy The field name to use when ordering the results.
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string contractId The contractId
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string pageSize Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work.
query string pageNumber Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.
query string checkEntitlement Option to force an entitlement check.
query boolean
Get category details application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/categoryview/byId/{categoryId}
Tags: Category ViewGets category details based on the unique ID assigned by the database.
storeId The store ID.
path string categoryId The category identifier that was assigned by the database.
path string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string contractId The contractId
query string checkEntitlement Option to force an entitlement check.
query boolean
Get category details application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/categoryview/byIds
Tags: Category ViewGets category details based on the unique ID.
storeId The store ID.
path string id The list of category identifiers.
query string[] , multiple parameters (id=aaa&id=bbb) catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string orderBy The field name to use when ordering the results.
query string contractId The contractId
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string checkEntitlement Option to force an entitlement check.
query boolean
Get child categories application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/categoryview/byParentCategory/{parentCategoryId}
Tags: Category ViewGets child categories based on the parent category unique ID.
storeId The store ID.
path string parentCategoryId The parent category id.
path string depthAndLimit The comma separated list of numbers is to control the depth of sub-categories and limit the number of items returned under each child category level. The first number in this list determines the maximum of categories (first level sub-categories) to be returned under the immediate child category. The second number in the list determines the maximum number of categories to be returned under the first level sub-categories. A value of "-1" implies no limit. In that case, only the first level categories will be returned. For example, "pageSize=4&limitSubCategories=-1,3,0,1" implies that there will be unlimited first level sub-categories under the immediate child categories. Under these categories (up to 4), all sub-categories will be returned and a maximum of 3 second level sub-categories will be returned. There will be no third level or fourth level since the third level limit is 0. Any level after a limit of 0 will be ignored. By default, no sub-category will be returned if this parameter is not specified. When the asterisk "*" is specified, it is considered the same as "-1" but, any subsequent levels will also be treated "-1".
query string orderBy The field name to use when ordering the results.
query string contractId The contractId
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string pageSize Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work.
query string pageNumber Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.
query string checkEntitlement Option to force an entitlement check.
query boolean
Get category details application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/categoryview/{categoryIdentifier}
Tags: Category ViewGets category details based on its identifier (not the by the ID assigned by the database).
storeId The store ID.
path string categoryIdentifier The category identifier that was configured, not the one assigned by the database.
path string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string contractId The contractId
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string checkEntitlement Option to force an entitlement check.
query boolean
Get all products application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/productview/byCategory/{categoryId}
Tags: Product ViewGets all products under the category and subcategories by deep search. It does not only return products in the current category.
storeId The store ID.
path string categoryId The category identifier.
path string associationType The type of the merchandising association to be returned.
query string attributeKeyword The attribute associated keywords to be returned.
query string facet The selected facets.
query string facetLimit The multiple name-value pairs of facet limit defining the maximum number of items to be returned under each facet. The sequence of limits honored alongside with the sequence of facet name-value pairs.
query string advancedFacetList The advanced facet list.
query string filterFacet The filter facet.
query string filterTerm The filter term.
query string manufacturer The manufacturer name.
query string contractId The contractId
query string minPrice The minimum price. Based on the selected currency.
query string maxPrice The maximum price. Based on the selected currency.mc
query string orderBy The field name to use when ordering the results.
query string searchType The search type is a numeric string with controls the query operator: ANY, OR, AND and control what data to be returned. For a detailed list of valid values, see the online documentation on Match type (_wcf.search.type). Known valid values include : 0: ANY (exclude SKU)1: EXACT (exclude SKU), 2: ALL (exclude SKU), 3: NONE (exclude SKU), 10: ANY (include SKU), 11: EXACT (include SKU), 12: ALL (include SKU), 13: NONE (include SKU), 100: ANY (only SKU), 101: EXACT (only SKU), 102: ALL (only SKU), 103: NONE (only SKU), 1000: ANY (include products, kits, bundles, category level SKU) (exclude product level SKU), 1001: EXACT (include products, kits, bundles, category level SKU) (exclude product level SKU), 1002: ALL (include products, kits, bundles, category level SKU) (exclude product level SKU), 1003: NONE (include products, kits, bundles, category level SKU) (exclude product level SKU), 10000: ANY (include category level SKU) (exclude products, kits, bundles, product level SKU), 10001: EXACT (include category level SKU) (exclude products, kits, bundles, product level SKU), 10002: ALL (include category level SKU) (exclude products, kits, bundles, product level SKU), 10003: NONE (include category level SKU) (exclude products, kits, bundles, product level SKU)
query string searchSource The search source. The default is "N" for shallow search navigation. All other values will result in expanded search in sub-categories.
query string priceMode The price mode.
query string checkEntitlement Option to force an entitlement check.
query boolean attachementFilter The attachment filter.
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string pageSize Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work.
query string pageNumber Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.
query string
Get all products application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/productview/byCategoryForAdmin/{categoryId}
Tags: Product ViewGets all products under the category and subcategories by deep search. It does not only return products in the current category. The search is performed as an administrative user.
storeId The store ID.
path string categoryId The category identifier.
path string associationType The type of the merchandising association to be returned.
query string attributeKeyword The attribute associated keywords to be returned.
query string facet The selected facets.
query string facetLimit The multiple name-value pairs of facet limit defining the maximum number of items to be returned under each facet. The sequence of limits honored alongside with the sequence of facet name-value pairs.
query string advancedFacetList The advanced facet list.
query string filterFacet The filter facet.
query string filterTerm The filter term.
query string manufacturer The manufacturer name.
query string contractId The contractId
query string minPrice The minimum price. Based on the selected currency.
query string maxPrice The maximum price. Based on the selected currency.mc
query string orderBy The field name to use when ordering the results.
query string searchType The search type is a numeric string with controls the query operator: ANY, OR, AND and control what data to be returned. For a detailed list of valid values, see the online documentation on Match type (_wcf.search.type). Known valid values include : 0: ANY (exclude SKU)1: EXACT (exclude SKU), 2: ALL (exclude SKU), 3: NONE (exclude SKU), 10: ANY (include SKU), 11: EXACT (include SKU), 12: ALL (include SKU), 13: NONE (include SKU), 100: ANY (only SKU), 101: EXACT (only SKU), 102: ALL (only SKU), 103: NONE (only SKU), 1000: ANY (include products, kits, bundles, category level SKU) (exclude product level SKU), 1001: EXACT (include products, kits, bundles, category level SKU) (exclude product level SKU), 1002: ALL (include products, kits, bundles, category level SKU) (exclude product level SKU), 1003: NONE (include products, kits, bundles, category level SKU) (exclude product level SKU), 10000: ANY (include category level SKU) (exclude products, kits, bundles, product level SKU), 10001: EXACT (include category level SKU) (exclude products, kits, bundles, product level SKU), 10002: ALL (include category level SKU) (exclude products, kits, bundles, product level SKU), 10003: NONE (include category level SKU) (exclude products, kits, bundles, product level SKU)
query string searchSource The search source. The default is "N" for shallow search navigation. All other values will result in expanded search in sub-categories.
query string priceMode The price mode.
query string checkEntitlement Option to force an entitlement check.
query string attachementFilter The attachment filter.
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string pageSize Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work.
query string sequenceRule The dynamic sequencing formula to be applied on the search results,
query string excludeIds The list of product to be excluded from the search results , this is comma separated productId
query string debug Used to display debug info. Set to 'true' to display sequence score.
query string pageNumber Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.
query string
Get product details application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/productview/byId/{productId}
Tags: Product ViewGets product details based on the product ID.
storeId The store ID.
path string productId The product identifier.
path string associationType The type of the merchandising association to be returned.
query string attributeKeyword The attribute associated keywords to be returned.
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string contractId The contractId
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string checkEntitlement Option to force an entitlement check.
query boolean attachementFilter The attachment filter.
query string
Get product details application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/productview/byIds
Tags: Product ViewGets product details based on the product ID.
storeId The store ID.
path string id The product identifiers.
query string[] , multiple parameters (id=aaa&id=bbb) associationType The type of the merchandising association to be returned.
query string attributeKeyword The attribute associated keywords to be returned.
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string contractId The contractId
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string checkEntitlement Option to force an entitlement check.
query boolean attachementFilter The attachment filter.
query string
Get products by parts application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/productview/byPartNumbers
Tags: Product ViewGets products by part numbers.
storeId The store ID.
path string partNumber The product part numbers.
query string[] , multiple parameters (partNumber=aaa&partNumber=bbb) associationType The type of the merchandising association to be returned.
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string contractId The contractId
query string checkEntitlement Option to force an entitlement check.
query boolean attachementFilter The attachment filter.
query string
Get product details application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/productview/bySearchTerm/{searchTerm}
Tags: Product ViewGets product details based on a search term.
storeId The store ID.
path string searchTerm The term to search for.
path string associationType The type of the merchandising association to be returned.
query string attributeKeyword The attribute associated keywords to be returned.
query string facet The selected facets.
query string facetLimit The multiple name-value pairs of facet limit defining the maximum number of items to be returned under each facet. The sequence of limits honored alongside with the sequence of facet name-value pairs.
query string advancedFacetList The advanced facet list.
query string filterFacet The filter facet.
query string contractId The contractId
query string filterTerm The filter term.
query string manufacturer The manufacturer name.
query string minPrice The minimum price. Based on the selected currency.
query string maxPrice The maximum price. Based on the selected currency.mc
query string orderBy The field name to use when ordering the results.
query string searchType The search type is a numeric string with controls the query operator: ANY, OR, AND and control what data to be returned. For a detailed list of valid values, see the online documentation on Match type (_wcf.search.type). Known valid values include : 0: ANY (exclude SKU)1: EXACT (exclude SKU), 2: ALL (exclude SKU), 3: NONE (exclude SKU), 10: ANY (include SKU), 11: EXACT (include SKU), 12: ALL (include SKU), 13: NONE (include SKU), 100: ANY (only SKU), 101: EXACT (only SKU), 102: ALL (only SKU), 103: NONE (only SKU), 1000: ANY (include products, kits, bundles, category level SKU) (exclude product level SKU), 1001: EXACT (include products, kits, bundles, category level SKU) (exclude product level SKU), 1002: ALL (include products, kits, bundles, category level SKU) (exclude product level SKU), 1003: NONE (include products, kits, bundles, category level SKU) (exclude product level SKU), 10000: ANY (include category level SKU) (exclude products, kits, bundles, product level SKU), 10001: EXACT (include category level SKU) (exclude products, kits, bundles, product level SKU), 10002: ALL (include category level SKU) (exclude products, kits, bundles, product level SKU), 10003: NONE (include category level SKU) (exclude products, kits, bundles, product level SKU)
query string searchSource The search source. The default is "N" for shallow search navigation. All other values will result in expanded search in sub-categories.
query string priceMode The price mode.
query string checkEntitlement Option to force an entitlement check.
query boolean categoryId The category identifier.
query string searchTerm The optional searchTerm parameter that will replace the {searchTerm} value in the context path parameter. It is used to avoid potential limitation of the special characters as being part of the context path.
query string intentSearchTerm The value of the parameter is the term that the user intends to search. Characters are not escaped for the search engine.
query string originalSearchTerm The value of the parameter is the term that the user intends to search. Characters are escaped for the search engine.
query string filterType Used for advanced search option. 0 - search for any match, 1 - search for exact match, 2 - search for all matches
query string physicalStoreIds The list of physical store identifiers.
query string attachementFilter The attachment filter.
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string pageSize Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work.
query string pageNumber Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.
query string
Get products by part application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/productview/{partNumber}
Tags: Product ViewGets products by part number.
storeId The store ID.
path string partNumber The product part number.
path string associationType The type of the merchandising association to be returned.
query string attributeKeyword The attribute associated keywords to be returned.
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string contractId The contractId
query string currency The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string checkEntitlement Option to force an entitlement check.
query boolean attachementFilter The attachment filter.
query string
Provide brand suggestions application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/sitecontent/brandSuggestions
Tags: Site ContentProvides brand suggestions with type-ahead for the search result page.
storeId The store ID.
path string limit Limit.
query string count The number of suggested keywords to be returned. Default is 4.
query string contractId The contractId
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string termsSort The sorting to be used in the returned result, "count" or "index". By default, it is "count".
query boolean catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string
Provide category suggestions application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/sitecontent/categorySuggestions
Tags: Site ContentProvides category suggestions with type-ahead for search result page.
storeId The store ID.
path string limit Limit.
query string count The number of suggested keywords to be returned. Default is 4.
query string contractId The contractId
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string termsSort The sorting to be used in the returned result, "count" or "index". By default, it is "count".
query boolean catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string
Provide custom suggestions application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/sitecontent/customSuggestions
Tags: Site ContentProvides custom suggestions with type-ahead for the search result page.
storeId The store ID.
path string term The term to search for.
query string suggestType The suggestion type. Accepted values are 'Category', 'Brand', 'Articles', 'Keyword', and 'Product'.
query string limit Limit.
query string count The number of suggested keywords to be returned. Default is 4.
query string pageSize Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string pageNumber Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.
query string searchType The search type is a numeric string with controls the query operator: ANY, OR, AND and control what data to be returned. For a detailed list of valid values, see the online documentation on Match type (_wcf.search.type). Known valid values include : 0: ANY (exclude SKU)1: EXACT (exclude SKU), 2: ALL (exclude SKU), 3: NONE (exclude SKU), 10: ANY (include SKU), 11: EXACT (include SKU), 12: ALL (include SKU), 13: NONE (include SKU), 100: ANY (only SKU), 101: EXACT (only SKU), 102: ALL (only SKU), 103: NONE (only SKU), 1000: ANY (include products, kits, bundles, category level SKU) (exclude product level SKU), 1001: EXACT (include products, kits, bundles, category level SKU) (exclude product level SKU), 1002: ALL (include products, kits, bundles, category level SKU) (exclude product level SKU), 1003: NONE (include products, kits, bundles, category level SKU) (exclude product level SKU), 10000: ANY (include category level SKU) (exclude products, kits, bundles, product level SKU), 10001: EXACT (include category level SKU) (exclude products, kits, bundles, product level SKU), 10002: ALL (include category level SKU) (exclude products, kits, bundles, product level SKU), 10003: NONE (include category level SKU) (exclude products, kits, bundles, product level SKU)
query string contractId The contractId
query string termsSort The sorting to be used in the returned result, "count" or "index". By default, it is "count".
query boolean catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string
Provide keyword suggestions application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/sitecontent/keywordSuggestionsByTerm/{term}
Tags: Site ContentProvides keyword suggestions with type-ahead for search result page based on a term.
storeId The store ID.
path string term The search term.
path string limit Limit.
query string count The number of suggested keywords to be returned. Default is 4.
query string contractId The contractId
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string termsSort The sorting to be used in the returned result, "count" or "index". By default, it is "count".
query boolean catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string
Provide product suggestions application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/sitecontent/productSuggestionsBySearchTerm/{searchTerm}
Tags: Site ContentProvides product suggestions with type-ahead for search result page.
storeId The store ID.
path string searchTerm The term to search for.
path string pageSize Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work.
query string pageNumber Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.
query string searchType The search type is a numeric string with controls the query operator: ANY, OR, AND and control what data to be returned. For a detailed list of valid values, see the online documentation on Match type (_wcf.search.type). Known valid values include : 0: ANY (exclude SKU)1: EXACT (exclude SKU), 2: ALL (exclude SKU), 3: NONE (exclude SKU), 10: ANY (include SKU), 11: EXACT (include SKU), 12: ALL (include SKU), 13: NONE (include SKU), 100: ANY (only SKU), 101: EXACT (only SKU), 102: ALL (only SKU), 103: NONE (only SKU), 1000: ANY (include products, kits, bundles, category level SKU) (exclude product level SKU), 1001: EXACT (include products, kits, bundles, category level SKU) (exclude product level SKU), 1002: ALL (include products, kits, bundles, category level SKU) (exclude product level SKU), 1003: NONE (include products, kits, bundles, category level SKU) (exclude product level SKU), 10000: ANY (include category level SKU) (exclude products, kits, bundles, product level SKU), 10001: EXACT (include category level SKU) (exclude products, kits, bundles, product level SKU), 10002: ALL (include category level SKU) (exclude products, kits, bundles, product level SKU), 10003: NONE (include category level SKU) (exclude products, kits, bundles, product level SKU)
query string term The sorting to be used in the returned result, "count" or "index". By default, it is "count".
query boolean contractId The contractId
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string termsSort The sorting to be used in the returned result, "count" or "index". By default, it is "count".
query boolean catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string checkEntitlement Option to force an entitlement check.
query boolean
Provide suggestions application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/sitecontent/suggestions
Tags: Site ContentProvides suggestions with type-ahead for search result page.
storeId The store ID.
path string suggestType The suggestion type. Accepted values are 'Category', 'Brand', 'Articles', 'Keyword', and 'Product'.
query string term The search term.
query string limit Limit.
query string count The number of suggested keywords to be returned. Default is 4.
query string contractId The contractId
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string termsSort The sorting to be used in the returned result, "count" or "index". By default, it is "count".
query boolean catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string
Search unstructured content application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/sitecontent/webContentsBySearchTerm/{searchTerm}
Tags: Site ContentSearches unstructured content details for search result page based on a search term.
storeId The store ID.
path string searchTerm The term to search for.
path string facet The selected facets.
query string facetLimit The multiple name-value pairs of facet limit defining the maximum number of items to be returned under each facet. The sequence of limits honored alongside with the sequence of facet name-value pairs.
query string orderBy The field name to use when ordering the results.
query string catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string pageSize Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work.
query string pageNumber Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.
query string
Provide content suggestion application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/sitecontent/webContentSuggestions
Tags: Site ContentProvides web content suggestions with type-ahead for the search result page.
storeId The store ID.
path string limit Limit.
query string count The number of suggested keywords to be returned. Default is 4.
query string langId Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used.
query string termsSort The sorting to be used in the returned result, "count" or "index". By default, it is "count".
query boolean catalogId The catalog identifier. If none is specified, the store default catalog shall be used.
query string
application/json
- 200 OK
The requested completed successfully.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
Schema definitions