{ "openapi": "3.0.1", "info": { "title": "Query Service", "description": "Provide Query Service Api Documentation", "version": "9.1.20.0", "x-introduced": "9.1.0.0" }, "servers": [ { "url": "https://{hostname}:{port}/search/resources", "description": "Toolkit server url", "variables": { "port": { "default": "443", "enum": [ "443", "30900" ] }, "hostname": { "default": "localhost", "enum": [ "localhost", "test.hcl.com" ] } } } ], "tags": [ { "name": "V2-Url-Resource", "description": "This class provides RESTful services to get SEO data for specified resources." }, { "name": "V2-Product-Resource", "description": "This class provides RESTful services to get the ProductView details." }, { "name": "V2-Category-Resource", "description": "This class provides RESTful services to get category data for search-based catalog navigation for V2.0 store." }, { "name": "V2-Data-Status", "description": "This class provides RESTful services to get Status of Connectors." }, { "name": "Site-Content-Resource", "description": "This class provides RESTful services to get resource details for site content." }, { "name": "Search-Profile-Resource", "description": "This class provides RESTful services to create search profile. Not available for live environment." }, { "name": "Search-Document-Resource", "description": "This class provides RESTful services for BOD. Not available for live environment." }, { "name": "Search-Config-Resource", "description": "This class provides RESTful services to add configuration data in ZooKeeper. Available for data and toolkit environment only." }, { "name": "Product-View-Resource", "description": "This class provides RESTful services to get the ProductView details." }, { "name": "Category-View-Resource", "description": "This class provides RESTful services to get category data for search-based catalog navigation. It performs the services by delegating to the CatalogNavigationView BOD service." }, { "name": "Search-Ranking-Resource", "description": "This class provides RESTful services to create, read, update and delete search rankings." } ], "paths": { "/store/{storeId}/categoryview/{categoryIdentifier}": { "get": { "tags": [ "Category-View-Resource" ], "summary": "Gets category details based on its identifier (not the ID assigned by the database).", "operationId": "findCategoryByIdentifier", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogGroupDetailArray" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/categoryview/@top": { "get": { "tags": [ "Category-View-Resource" ], "summary": "Gets all top level categories.", "operationId": "findTopCategories", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depthAndLimit", "in": "query", "schema": { "type": "string", "description": "The comma separated list of numbers is used 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 number 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\"." } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "description": "The field name to use when ordering the results." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "description": "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." } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "description": "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogGroupDetailArray" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/categoryview/byParentCategory/{parentCategoryId}": { "get": { "tags": [ "Category-View-Resource" ], "summary": "Gets child categories based on the unique Id assigned to the parent category by the database.", "operationId": "findSubCategories", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parentCategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depthAndLimit", "in": "query", "schema": { "type": "string", "description": "The comma separated list of numbers is used 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 number 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\"." } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "description": "The field name to use when ordering the results." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "description": "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." } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "description": "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogGroupDetailArray" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/categoryview/byId/{categoryId}": { "get": { "tags": [ "Category-View-Resource" ], "summary": "Gets category details based on the unique ID assigned to the category by the database.", "operationId": "findCategoryByUniqueId", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogGroupDetailArray" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/categoryview/byIds": { "get": { "tags": [ "Category-View-Resource" ], "summary": "Gets category details based on a list of unique IDs assigned to the categories by the database.", "operationId": "findCategoriesByUniqueIds", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "description": "The field name to use when ordering the results." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogGroupDetailArray" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/categoryview/byIdentifiers": { "get": { "tags": [ "Category-View-Resource" ], "summary": "Gets category details based on category identifiers specified (not the id assigned by the database).", "operationId": "findCategoryByIdentifiers", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "description": "The field name to use when ordering the results." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogGroupDetailArray" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/productview/{partNumber}": { "get": { "tags": [ "Product-View-Resource" ], "summary": "Gets products by part number.", "operationId": "findProductByPartNumber", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "associationType", "in": "query", "schema": { "type": "string", "description": "The type of the merchandising association to be returned." } }, { "name": "attributeKeyword", "in": "query", "schema": { "type": "string", "description": "The attribute associated keywords to be returned." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "attachmentFilter", "in": "query", "schema": { "type": "string", "description": "The attachment filter." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailArray" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/productview/byPartNumber/{partNumber}": { "get": { "tags": [ "Product-View-Resource" ], "summary": "Gets products by part number.", "operationId": "findProductByAPartNumber", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "associationType", "in": "query", "schema": { "type": "string", "description": "The type of the merchandising association to be returned." } }, { "name": "attributeKeyword", "in": "query", "schema": { "type": "string", "description": "The attribute associated keywords to be returned." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "attachmentFilter", "in": "query", "schema": { "type": "string", "description": "The attachment filter." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailArray" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/productview/bySearchTerm/{searchTerm}": { "get": { "tags": [ "Product-View-Resource" ], "summary": "Gets product details based on a search term.", "operationId": "findProductsBySearchTerm", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "searchTerm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string", "description": "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." } }, { "name": "associationType", "in": "query", "schema": { "type": "string", "description": "The type of the merchandising association to be returned." } }, { "name": "attributeKeyword", "in": "query", "schema": { "type": "string", "description": "The attribute associated keywords to be returned." } }, { "name": "facet", "in": "query", "schema": { "type": "string", "description": "The selected facets." } }, { "name": "facetLimit", "in": "query", "schema": { "type": "string", "description": "The multiple name-value pairs of the 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." } }, { "name": "advancedFacetList", "in": "query", "schema": { "type": "string", "description": "The advanced facet list." } }, { "name": "filterFacet", "in": "query", "schema": { "type": "string", "description": "The filter facet." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "filterTerm", "in": "query", "schema": { "type": "string", "description": "The filter term." } }, { "name": "manufacturer", "in": "query", "schema": { "type": "string", "description": "The manufacturer name." } }, { "name": "minPrice", "in": "query", "schema": { "type": "integer", "description": "The minimum price. Based on the selected currency." } }, { "name": "maxPrice", "in": "query", "schema": { "type": "integer", "description": "The maximum price for the product based on the selected currency." } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "description": "The field name to use when ordering the results." } }, { "name": "searchType", "in": "query", "schema": { "type": "integer", "description": "The search type is a numeric string which 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)" } }, { "name": "searchSource", "in": "query", "schema": { "type": "string", "description": "The search source. The default is \"N\" for shallow search navigation. All other values will result in expanded search in sub-categories." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "categoryId", "in": "query", "schema": { "type": "string", "description": "The category identifier." } }, { "name": "physicalStoreIds", "in": "query", "schema": { "type": "string", "description": "The list of physical store identifiers." } }, { "name": "attachmentFilter", "in": "query", "schema": { "type": "string", "description": "The attachment filter." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "description": "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." } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "description": "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "disableSearchRules", "in": "query", "schema": { "type": "boolean", "description": "This field is used to disable search rules and rankings for fetching organic search results" } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSummaryWithGroupingArray" } } } } } } }, "/store/{storeId}/productview/byCategory/{categoryId}": { "get": { "tags": [ "Product-View-Resource" ], "summary": "Finds a product by its ID.", "operationId": "findProductsByCategory", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "associationType", "in": "query", "schema": { "type": "string", "description": "The type of the merchandising association to be returned." } }, { "name": "attributeKeyword", "in": "query", "schema": { "type": "string", "description": "The attribute associated keywords to be returned." } }, { "name": "facet", "in": "query", "schema": { "type": "string", "description": "The selected facets." } }, { "name": "facetLimit", "in": "query", "schema": { "type": "string", "description": "The multiple name-value pairs of the 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." } }, { "name": "advancedFacetList", "in": "query", "schema": { "type": "string", "description": "The advanced facet list." } }, { "name": "filterFacet", "in": "query", "schema": { "type": "string", "description": "The filter facet." } }, { "name": "filterTerm", "in": "query", "schema": { "type": "string", "description": "The filter term." } }, { "name": "manufacturer", "in": "query", "schema": { "type": "string", "description": "The manufacturer name." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "minPrice", "in": "query", "schema": { "type": "integer", "description": "The minimum price. Based on the selected currency." } }, { "name": "maxPrice", "in": "query", "schema": { "type": "integer", "description": "The maximum price for the product based on the selected currency." } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "description": "The field name to use when ordering the results." } }, { "name": "searchType", "in": "query", "schema": { "type": "integer", "description": "The search type is a numeric string which 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)" } }, { "name": "searchSource", "in": "query", "schema": { "type": "string", "description": "The search source. The default is \"N\" for shallow search navigation. All other values will result in expanded search in sub-categories." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "attachmentFilter", "in": "query", "schema": { "type": "string", "description": "The attachment filter." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "description": "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." } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "description": "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSummaryArray" } } } } } } }, "/store/{storeId}/productview/byCategoryForAdmin/{categoryId}": { "get": { "tags": [ "Product-View-Resource" ], "summary": "By default, this API returns all products under the category and subcategories by deep search. It does not only return products in the current category. There is no control over the limit of each subcategory under the category facet.", "operationId": "findProductsByCategoryForAdmin", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "associationType", "in": "query", "schema": { "type": "string", "description": "The type of the merchandising association to be returned." } }, { "name": "attributeKeyword", "in": "query", "schema": { "type": "string", "description": "The attribute associated keywords to be returned." } }, { "name": "facet", "in": "query", "schema": { "type": "string", "description": "The selected facets." } }, { "name": "facetLimit", "in": "query", "schema": { "type": "string", "description": "The multiple name-value pairs of the 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." } }, { "name": "advancedFacetList", "in": "query", "schema": { "type": "string", "description": "The advanced facet list." } }, { "name": "filterFacet", "in": "query", "schema": { "type": "string", "description": "The filter facet." } }, { "name": "filterTerm", "in": "query", "schema": { "type": "string", "description": "The filter term." } }, { "name": "manufacturer", "in": "query", "schema": { "type": "string", "description": "The manufacturer name." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "minPrice", "in": "query", "schema": { "type": "string", "description": "The minimum price. Based on the selected currency." } }, { "name": "maxPrice", "in": "query", "schema": { "type": "string", "description": "The maximum price for the product based on the selected currency." } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "description": "The field name to use when ordering the results." } }, { "name": "searchType", "in": "query", "schema": { "type": "string", "description": "The search type is a numeric string which 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)" } }, { "name": "searchSource", "in": "query", "schema": { "type": "string", "description": "The search source. The default is \"N\" for shallow search navigation. All other values will result in expanded search in sub-categories." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "string", "description": "Option to force an entitlement check." } }, { "name": "attachmentFilter", "in": "query", "schema": { "type": "string", "description": "The attachment filter." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "pageSize", "in": "query", "schema": { "type": "string", "description": "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." } }, { "name": "debug", "in": "query", "schema": { "type": "string", "description": "Used to display debug info. Set to 'true' to display sequence score." } }, { "name": "pageNumber", "in": "query", "schema": { "type": "string", "description": "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Not authenticated. The user session is not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "403": { "description": "The user is not authorized to perform the specified request.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSummaryArray" } } } } } } }, "/store/{storeId}/productview/byPartNumbers": { "get": { "tags": [ "Product-View-Resource" ], "summary": "Gets products by part numbers.", "operationId": "findProductByPartNumbers", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partNumber", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "associationType", "in": "query", "schema": { "type": "string", "description": "The type of the merchandising association to be returned." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "attachmentFilter", "in": "query", "schema": { "type": "string", "description": "The attachment filter." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailArray" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/productview/byIds": { "get": { "tags": [ "Product-View-Resource" ], "summary": "Gets product details based on the product ID.", "operationId": "findProductsByIds", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "associationType", "in": "query", "schema": { "type": "string", "description": "The type of the merchandising association to be returned." } }, { "name": "attributeKeyword", "in": "query", "schema": { "type": "string", "description": "The attribute associated keywords to be returned." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "attachmentFilter", "in": "query", "schema": { "type": "string", "description": "The attachment filter." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailArray" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/productview/byId/{productId}": { "get": { "tags": [ "Product-View-Resource" ], "summary": "Gets product details based on the product ID.", "operationId": "findProductById", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "associationType", "in": "query", "schema": { "type": "string", "description": "The type of the merchandising association to be returned." } }, { "name": "attributeKeyword", "in": "query", "schema": { "type": "string", "description": "The attribute associated keywords to be returned." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "attachmentFilter", "in": "query", "schema": { "type": "string", "description": "The attachment filter." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "Optional this is seller identifier" } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailArray" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/configuration": { "get": { "tags": [ "Search-Config-Resource" ], "summary": "Get the configuration node data from ZooKeeper.", "operationId": "getConfigurationData", "parameters": [ { "name": "nodeName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "envType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "schema": { "type": "string", "description": "Locale name" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "tags": [ "Search-Config-Resource" ], "summary": "Create the configuration node in ZooKeeper.", "operationId": "addConfiguration", "parameters": [ { "name": "nodeName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "envType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "schema": { "type": "string", "description": "Locale name" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "The requested resource has been created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } }, "put": { "tags": [ "Search-Config-Resource" ], "summary": "Use to perform Push To Live operation from authoring to live environment.", "operationId": "performZKPushToLive", "responses": { "201": { "description": "The requested resource has been created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } }, "patch": { "tags": [ "Search-Config-Resource" ], "summary": "Update the configuration node in ZooKeeper.", "operationId": "updateConfigurationData", "parameters": [ { "name": "nodeName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "envType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "schema": { "type": "string", "description": "Locale name" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "The requested resource has been created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/api/v2/configuration/colors": { "get": { "tags": [ "Search-Config-Resource" ], "summary": "Get the Colors configuration data from ZooKeeper.", "operationId": "getColorConfig", "parameters": [ { "name": "storeId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "envType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": true, "schema": { "type": "string", "description": "Locale name" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "patch": { "tags": [ "Search-Config-Resource" ], "summary": "Update the Colors configuration data in ZooKeeper.", "operationId": "updateColorConfig", "parameters": [ { "name": "storeId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "envType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": true, "schema": { "type": "string", "description": "Locale name" } } ], "responses": { "201": { "description": "The requested resource has been created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/api/v2/documents/bod": { "post": { "tags": [ "Search-Document-Resource" ], "summary": "Gets BOD data.", "operationId": "getMarketingESpotData", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/documents/profiles/{profileName}": { "get": { "tags": [ "Search-Profile-Resource" ], "summary": "Get the search profile.", "operationId": "getSearchProfile", "parameters": [ { "name": "profileName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileType", "in": "query", "schema": { "type": "string", "description": "Type of the profile.", "enum": [ "Search", "NLP" ] } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchProfile" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchProfile" } } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchProfile" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchProfile" } } } } } } }, "put": { "tags": [ "Search-Profile-Resource" ], "summary": "Update the search profile.", "operationId": "updateSearchProfile", "parameters": [ { "name": "profileName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileType", "in": "query", "schema": { "type": "string", "description": "Type of the profile.", "enum": [ "Search", "NLP" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/SearchProfile" } } } }, "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "201": { "description": "The requested resource has been created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } }, "post": { "tags": [ "Search-Profile-Resource" ], "summary": "Create the search profile.", "operationId": "createSearchProfile", "parameters": [ { "name": "profileName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileType", "in": "query", "schema": { "type": "string", "description": "Type of the profile.", "enum": [ "Search", "NLP" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/SearchProfile" } } } }, "responses": { "201": { "description": "The requested resource has been created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "409": { "description": "The specified resource already exist.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } }, "delete": { "tags": [ "Search-Profile-Resource" ], "summary": "Delete the search profile.", "operationId": "deleteProfile", "parameters": [ { "name": "profileName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileType", "in": "query", "schema": { "type": "string", "description": "Type of the profile.", "enum": [ "Search", "NLP" ] } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "204": { "description": "The requested completed successfully. No content is returned in the response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/api/v2/documents/profiles": { "get": { "tags": [ "Search-Profile-Resource" ], "summary": "Gets the search profiles.", "operationId": "getSearchProfileList", "parameters": [ { "name": "profileType", "in": "query", "schema": { "type": "string", "description": "Type of the profile.", "enum": [ "Search", "NLP" ] } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchProfile" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchProfile" } } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchProfile" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchProfile" } } } } } } } }, "/store/{storeId}/sitecontent/categorySuggestions": { "get": { "tags": [ "Site-Content-Resource" ], "summary": "Provides suggestions with type-ahead for search result page.", "operationId": "findCategorySuggestions", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "description": "Limit." } }, { "name": "count", "in": "query", "schema": { "type": "integer", "description": "The number of suggested keywords to be returned. The default value is 4." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "termsSort", "in": "query", "schema": { "type": "boolean", "description": "The sorting to be used in the returned result, \"count\" or \"index\". By default, it is \"count\"." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorySuggestion" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/sitecontent/keywordSuggestionsByTerm/{term}": { "get": { "tags": [ "Site-Content-Resource" ], "summary": "Provides keyword suggestions with type-ahead for search result page based on a term.", "operationId": "findKeywordSuggestionsByTerm", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "term", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string", "description": "Limit." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "termsSort", "in": "query", "schema": { "type": "boolean", "description": "The sorting to be used in the returned result, \"count\" or \"index\". By default, it is \"count\"." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordSuggestion" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/sitecontent/suggestions": { "get": { "tags": [ "Site-Content-Resource" ], "summary": "Provides suggestions with type-ahead for search result page.", "operationId": "findSuggestions", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "suggestType", "in": "query", "schema": { "type": "string", "description": "The suggestion type. Accepted values are 'Category', 'Brand', 'Articles', 'Keyword', and 'Product'." } }, { "name": "term", "in": "query", "schema": { "type": "string", "description": "The search term." } }, { "name": "limit", "in": "query", "schema": { "type": "string", "description": "Limit." } }, { "name": "count", "in": "query", "schema": { "type": "integer", "description": "The number of suggested keywords to be returned. The default value is 4." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "termsSort", "in": "query", "schema": { "type": "boolean", "description": "The sorting to be used in the returned result, \"count\" or \"index\". By default, it is \"count\"." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonSuggestions" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/sitecontent/productSuggestionsBySearchTerm/{searchTerm}": { "get": { "tags": [ "Site-Content-Resource" ], "summary": "Provides suggestions with type-ahead for search result page.", "operationId": "findProductSuggestionsBySearchTerm", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "searchTerm", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "description": "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." } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "description": "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work." } }, { "name": "searchType", "in": "query", "schema": { "type": "integer", "description": "The search type is a numeric string which 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)" } }, { "name": "term", "in": "query", "schema": { "type": "boolean", "description": "The sorting to be used in the returned result, \"count\" or \"index\". By default, it is \"count\"." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "termsSort", "in": "query", "schema": { "type": "boolean", "description": "The sorting to be used in the returned result, \"count\" or \"index\". By default, it is \"count\"." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSuggestion" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/store/{storeId}/sitecontent/brandSuggestions": { "get": { "tags": [ "Site-Content-Resource" ], "summary": "Provides suggestions with type-ahead for search result page.", "operationId": "findBrandSuggestions", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "description": "Limit." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "termsSort", "in": "query", "schema": { "type": "boolean", "description": "The sorting to be used in the returned result, \"count\" or \"index\". By default, it is \"count\"." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorySuggestion" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/categories": { "get": { "tags": [ "V2-Category-Resource" ], "summary": "Gets Response for V2.0 API for store as per the requirements", "operationId": "getV2CategoryResources", "parameters": [ { "name": "storeId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "parentCategoryId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depthAndLimit", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "This is Seller identifier." } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentArray" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/products": { "get": { "tags": [ "V2-Product-Resource" ], "summary": "Gets Products", "operationId": "findProducts", "parameters": [ { "name": "storeId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "searchSource", "in": "query", "required": false, "schema": { "type": "string", "description": "The search source. The default is \"N\" for shallow search navigation. All other values will result in expanded search in sub-categories." } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "productId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "partNumber", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "facet", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "facetLimit", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "associationType", "in": "query", "schema": { "type": "string", "description": "The type of the merchandising association to be returned." } }, { "name": "attributeKeyword", "in": "query", "schema": { "type": "string", "description": "The attribute associated keywords to be returned." } }, { "name": "catalogId", "in": "query", "schema": { "type": "string", "description": "The catalog identifier. If none is specified, the store default catalog will be used." } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "description": "The contractId" } }, { "name": "currency", "in": "query", "schema": { "type": "string", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency will be used." } }, { "name": "langId", "in": "query", "schema": { "type": "string", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" is not specified, then the store default language will be used." } }, { "name": "checkEntitlement", "in": "query", "schema": { "type": "boolean", "description": "Option to force an entitlement check." } }, { "name": "attachmentFilter", "in": "query", "schema": { "type": "string", "description": "The attachment filter." } }, { "name": "profileName", "in": "query", "schema": { "type": "string", "description": "Profile name. Profiles determine the subset of data to be returned by a search query." } }, { "name": "disableSearchRules", "in": "query", "schema": { "type": "boolean", "description": "This field is used to disable search rules and rankings for fetching organic search results." } }, { "name": "seller", "in": "query", "schema": { "type": "string", "description": "This is Seller identifier." } }, { "name": "searchType", "in": "query", "schema": { "type": "integer", "description": "The search type is a numeric string which 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)" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductContentArray" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/urls": { "get": { "tags": [ "V2-Url-Resource" ], "summary": "Gets Response for V2.0 API Seo url data", "operationId": "getV2CategoryResources_1", "parameters": [ { "name": "storeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "identifier", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UrlContentArray" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/data/status": { "get": { "tags": [ "V2-Data-Status" ], "summary": "Get the summary of all Ingest Connector Status", "operationId": "getAllIngestControllerStatus", "parameters": [ { "name": "storeId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "connector", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "envType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dataStatusEntry" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/rankings": { "get": { "tags": [ "Search-Ranking-Resource" ], "summary": "Gets all of the search rankings.", "operationId": "getSearchRankings", "parameters": [ { "name": "storeId", "in": "query", "required": true, "description": "The unique store identifier of the respective store", "example": "1, 2, 11, or 12", "schema": { "type": "integer" } }, { "name": "languageId", "in": "query", "required": true, "description": "The unique language identifier of the supported language", "example": "-1 (for English)", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRankingNameCollection" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/rankings/{id}": { "get": { "tags": [ "Search-Ranking-Resource" ], "summary": "Gets a search ranking by ID.", "operationId": "getSearchRankingById", "parameters": [ { "name": "storeId", "in": "query", "required": true, "description": "The unique store identifier of the respective store", "example": "1, 2, 11, or 12", "schema": { "type": "integer" } }, { "name": "languageId", "in": "query", "required": true, "description": "The unique language identifier of the supported language", "example": "-1 (for English)", "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "description": "The ID created during the creation of search ranking", "example": "chairs", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRanking" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Search-Ranking-Resource" ], "summary": "Delete the search rankings for this search term.", "operationId": "deleteSearchRankingById", "parameters": [ { "name": "storeId", "in": "query", "required": true, "description": "The unique store identifier of the respective store", "example": "1, 2, 11, or 12", "schema": { "type": "integer" } }, { "name": "languageId", "in": "query", "required": true, "description": "The unique language identifier of the supported language", "example": "-1 (for English)", "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "description": "The ID created during the creation of search ranking", "example": "chairs", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The requested completed successfully. No content is returned in the response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/api/v2/rankings/{id}/actions": { "post": { "tags": [ "Search-Ranking-Resource" ], "summary": "Creates a new search ranking for this search term.", "operationId": "createSearchRanking", "parameters": [ { "name": "storeId", "in": "query", "required": true, "description": "The unique store identifier of the respective store", "example": "1, 2, 11, or 12", "schema": { "type": "integer" } }, { "name": "languageId", "description": "The unique language identifier of the supported language", "example": "-1 (for English)", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "description": "The ID created during the creation of search ranking", "example": "chairs", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRankingAction" } } }, "required": true }, "responses": { "201": { "description": "The requested resource has been created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "409": { "description": "The specified resource already exist.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/api/v2/rankings/{id}/actions/{catalogEntryId}": { "delete": { "tags": [ "Search-Ranking-Resource" ], "summary": "Delete the search ranking action for this search term and catalog entry.", "operationId": "deleteSearchRankingActionById", "parameters": [ { "name": "storeId", "in": "query", "required": true, "description": "The unique store identifier of the respective store", "example": "1, 2, 11, or 12", "schema": { "type": "integer" } }, { "name": "languageId", "in": "query", "required": true, "description": "The unique language identifier of the supported language", "example": "-1 (for English)", "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "description": "The ID created during the creation of search ranking", "example": "chairs", "schema": { "type": "string" } }, { "name": "catalogEntryId", "in": "path", "required": true, "description": "The unique identifier of the product present in the database", "example": "10001", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The requested completed successfully. No content is returned in the response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } }, "patch": { "tags": [ "Search-Ranking-Resource" ], "summary": "Updates a search ranking for this search term and catalog entry.", "operationId": "updateSearchRanking", "parameters": [ { "name": "storeId", "in": "query", "required": true, "description": "The unique store identifier of the respective store", "example": "1, 2, 11, or 12", "schema": { "type": "integer" } }, { "name": "languageId", "in": "query", "required": true, "description": "The unique language identifier of the supported language", "example": "-1 (for English)", "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "description": "The ID created during the creation of search ranking", "example": "chairs", "schema": { "type": "string" } }, { "name": "catalogEntryId", "in": "path", "required": true, "description": "The unique identifier of the product present in the database", "example": "10001", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRankingAction" } } }, "required": true }, "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request are not valid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "404": { "description": "The specified resource could not be found.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } } }, "components": { "schemas": { "Attachment": { "type": "object", "properties": { "identifier": { "type": "string" }, "image": { "type": "string" }, "name": { "type": "string" }, "sequence": { "type": "string" }, "shortdesc": { "type": "string" }, "catentry_id": { "type": "integer", "format": "int64" }, "usage": { "type": "string" }, "attachmentAssetID": { "type": "integer", "format": "int64" }, "mimeType": { "type": "string" }, "attachmentAssetPath": { "type": "string" }, "attachmentAssetPathRaw": { "type": "string" } } }, "Attribute": { "type": "object", "properties": { "identifier": { "type": "string" }, "usage": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeValue" } }, "displayable": { "type": "string" }, "merchandisable": { "type": "string" }, "searchable": { "type": "string" }, "sequence": { "type": "string" }, "storeDisplay": { "type": "string" }, "name": { "type": "string" }, "facetable": { "type": "string" }, "comparable": { "type": "string" }, "uniqueID": { "type": "string" }, "swatchable": { "type": "string" }, "attribute.natural": { "type": "string" } } }, "AttributeValue": { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/AttributeValueItem" }, "sequence": { "$ref": "#/components/schemas/AttributeValueItem" }, "unitOfMeasure": { "$ref": "#/components/schemas/AttributeValueItem" }, "unitID": { "$ref": "#/components/schemas/AttributeValueItem" }, "image1": { "$ref": "#/components/schemas/AttributeValueItem" }, "value": { "$ref": "#/components/schemas/AttributeValueItem" }, "image1path": { "$ref": "#/components/schemas/AttributeValueItem" }, "uniqueID": { "$ref": "#/components/schemas/AttributeValueItem" }, "bindToVariant": { "$ref": "#/components/schemas/AttributeValueBooleanItem" } } }, "BreadCrumbTrailEntryView": { "type": "object", "properties": { "label": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" } } }, "CatalogGroupDetailArray": { "type": "object", "properties": { "catalogGroupView": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogGroupView" } }, "recordSetCount": { "type": "integer", "format": "int32" }, "recordSetTotal": { "type": "integer", "format": "int32" }, "recordSetComplete": { "type": "string" }, "recordSetStartNumber": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string" }, "resourceId": { "type": "string" } } }, "CatalogGroupView": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "shortDescription": { "type": "string" }, "parentCatalogGroupID": { "type": "string" }, "resourceId": { "type": "string" }, "uniqueID": { "type": "string" }, "fullImage": { "type": "string" }, "thumbnail": { "type": "string" }, "storeID": { "type": "integer", "format": "int32" }, "sequence": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "userData": { "$ref": "#/components/schemas/UserDataType" }, "childCatalogGroupID": { "type": "array", "items": { "type": "string" } }, "category.parent": { "type": "string" } } }, "CategoryAttachment": { "type": "object", "properties": { "mimeType": { "type": "string" }, "usage": { "type": "string" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } } } }, "Asset": { "type": "object", "properties": { "attachmentAssetID": { "type": "string" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "shortdesc": { "type": "string" }, "sequence": { "type": "number", "format": "double" }, "storeID": { "type": "string" }, "attachmentAssetPath": { "type": "string" }, "attachmentAssetPathRaw": { "type": "string" } } }, "CategorySuggestion": { "type": "object", "properties": { "suggestionView": { "type": "array", "items": { "$ref": "#/components/schemas/CategorySuggestionView" } } } }, "CategorySuggestionView": { "type": "object", "properties": { "categorySeparator": { "type": "string" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryViewEntry" } } } }, "CategoryViewEntry": { "type": "object", "properties": { "value": { "type": "string" }, "count": { "type": "string" }, "fullPath": { "type": "string" }, "fullPathCategoryIds": { "type": "string" }, "image": { "type": "string" }, "seo": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "shortDescription": { "type": "string" }, "userData": { "$ref": "#/components/schemas/UserDataType" } } }, "CatalogEntryView": { "type": "object", "properties": { "hasSingleSKU": { "type": "boolean" }, "buyable": { "type": "string" }, "resourceId": { "type": "string" }, "uniqueID": { "type": "integer", "format": "int64" }, "parentCatalogGroupID": { "type": "array", "items": { "type": "string" } }, "sellerId": { "type": "string" }, "name": { "type": "string" }, "shortDescription": { "type": "string" }, "manufacturer": { "type": "string" }, "longDescription": { "type": "string" }, "catalogEntryTypeCode": { "type": "string" }, "thumbnailRaw": { "type": "string" }, "thumbnail": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "parentCatalogEntryID": { "type": "string" }, "partNumber": { "type": "string" }, "storeID": { "type": "string" }, "fullImageRaw": { "type": "string" }, "fullImage": { "type": "string" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/Image" } }, "userData": { "type": "array", "items": { "$ref": "#/components/schemas/UserDataType" } }, "numberOfSKUs": { "type": "string" }, "disallowRecurringOrder": { "type": "integer", "format": "int32" }, "keyword": { "type": "string" }, "singleSKUCatalogEntryID": { "type": "string" }, "subscriptionTypeCode": { "type": "string" } } }, "Component": { "type": "object", "properties": { "buyable": { "type": "string" }, "thumbnailRaw": { "type": "string" }, "resourceId": { "type": "string" }, "thumbnail": { "type": "string" }, "skus": { "type": "array", "items": { "$ref": "#/components/schemas/SKU" } }, "quantity": { "type": "string" }, "shortDescription": { "type": "string" }, "parentCatalogGroupID": { "type": "array", "items": { "type": "string" } }, "storeID": { "type": "string" }, "manufacturer": { "type": "string" }, "sellerId": { "type": "string" }, "numberOfSKUs": { "type": "integer", "format": "int32" }, "hasSingleSKU": { "type": "boolean" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "name": { "type": "string" }, "partNumber": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } }, "catalogEntryTypeCode": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "uniqueID": { "type": "integer", "format": "int64" } } }, "Child": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "shortDescription": { "type": "string" }, "parentCatalogGroupID": { "type": "string" }, "resourceId": { "type": "string" }, "uniqueID": { "type": "string" }, "thumbnail": { "type": "string" }, "storeID": { "type": "string" }, "sequence": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "id": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "description": { "type": "string" } } }, "CommonSuggestionEntry": { "type": "object", "properties": { "value": { "type": "string" }, "fullPath": { "type": "string" }, "fullPathCategoryIds": { "type": "string" }, "image": { "type": "string" }, "name": { "type": "string" }, "term": { "type": "string" }, "frequency": { "type": "integer", "format": "int32" }, "count": { "type": "string" }, "shortDescription": { "type": "string" }, "userData": { "$ref": "#/components/schemas/UserDataType" }, "seo": { "$ref": "#/components/schemas/Seo" } } }, "CommonSuggestionView": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/CommonSuggestionEntry" } }, "categorySeparator": { "type": "string" }, "userData": { "$ref": "#/components/schemas/UserDataType" } } }, "CommonSuggestions": { "type": "object", "properties": { "suggestionView": { "type": "array", "items": { "$ref": "#/components/schemas/CommonSuggestionView" } }, "resourceHandler": { "$ref": "#/components/schemas/ResourceHandler" } } }, "Content": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "shortDescription": { "type": "string" }, "parentCatalogGroupID": { "type": "string" }, "resourceId": { "type": "string" }, "uniqueID": { "type": "string" }, "thumbnail": { "type": "string" }, "storeID": { "type": "string" }, "sequence": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/Child" } }, "id": { "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "description": { "type": "string" }, "attachments": { "$ref": "#/components/schemas/CategoryAttachment" } } }, "ContentArray": { "type": "object", "properties": { "contents": { "type": "array", "items": { "$ref": "#/components/schemas/Content" } } } }, "dataStatusEntry": { "type": "object", "properties": { "date": { "type": "string" }, "message": { "type": "array", "items": { "type": "string" } }, "status": { "type": "integer", "format": "int32" } } }, "Entry": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "image": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "extendedData": { "$ref": "#/components/schemas/ExtendedData" } } }, "ExtendedData": { "type": "object", "properties": { "uniqueId": { "type": "integer", "format": "int64" }, "unitID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "sequence": { "type": "string" }, "parentIds": { "type": "string" }, "image1": { "type": "string" } } }, "FacetExtendedData": { "type": "object", "properties": { "fname": { "type": "string" }, "propertyvalue": { "type": "string" }, "maximumValuesToDisplay": { "type": "string" }, "displayable": { "type": "string" }, "allValuesReturned": { "type": "string" }, "zero_display": { "type": "string" }, "allowMultipleValueSelection": { "type": "string" }, "displaySequence": { "type": "string" }, "name": { "type": "string" }, "sortorder": { "type": "string" }, "max_display": { "type": "string" }, "fdesc": { "type": "string" }, "propertyId": { "type": "string" } } }, "FacetView": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/Entry" } }, "extendedData": { "$ref": "#/components/schemas/FacetExtendedData" } } }, "NlpParsingMetadata": { "type": "object", "properties": { "priceFilter": { "type": "string" }, "pos": { "type": "string" }, "ner": { "type": "string" }, "uom": { "type": "string" }, "fraction": { "type": "string" }, "dmm": { "type": "string" }, "color": { "type": "string" } } }, "GroupingProperties": { "type": "object", "properties": { "groupCount": { "type": "integer", "format": "int32" }, "groupOwner": { "type": "string" }, "groupHero": { "type": "string" } } }, "Image": { "type": "object", "properties": { "thumbnailRaw": { "type": "string" }, "sequence": { "type": "string" }, "thumbnail": { "type": "string" }, "name": { "type": "string" }, "fullImageRaw": { "type": "string" }, "fullImage": { "type": "string" } } }, "KeywordSuggestion": { "type": "object", "properties": { "suggestionView": { "type": "array", "items": { "$ref": "#/components/schemas/KeywordSuggestionView" } } } }, "KeywordSuggestionEntry": { "type": "object", "properties": { "term": { "type": "string" }, "frequency": { "type": "integer", "format": "int32" }, "userData": { "$ref": "#/components/schemas/UserDataType" } } }, "KeywordSuggestionView": { "type": "object", "properties": { "identifier": { "type": "string" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/KeywordSuggestionEntry" } } } }, "Links": { "type": "object", "properties": { "parent": { "$ref": "#/components/schemas/Parent" }, "children": { "type": "array", "items": { "type": "string" } }, "self": { "$ref": "#/components/schemas/Self" } } }, "Layout": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "containerName": { "type": "string" }, "slots": { "type": "array", "items": { "$ref": "#/components/schemas/Slot" } } } }, "MerchandisingAssociation": { "type": "object", "properties": { "buyable": { "type": "string" }, "thumbnailRaw": { "type": "string" }, "resourceId": { "type": "string" }, "thumbnail": { "type": "string" }, "skus": { "type": "array", "items": { "$ref": "#/components/schemas/SKU" } }, "quantity": { "type": "string" }, "associationType": { "type": "string" }, "shortDescription": { "type": "string" }, "parentCatalogGroupID": { "type": "array", "items": { "type": "string" } }, "storeID": { "type": "string" }, "manufacturer": { "type": "string" }, "sellerId": { "type": "string" }, "numberOfSKUs": { "type": "integer", "format": "int32" }, "hasSingleSKU": { "type": "boolean" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "name": { "type": "string" }, "partNumber": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } }, "catalogEntryTypeCode": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "uniqueID": { "type": "integer", "format": "int64" }, "relationship.item.id": { "type": "string" } } }, "MetaData": { "type": "object", "properties": { "price": { "type": "string" }, "searchExecution": { "type": "array", "items": { "$ref": "#/components/schemas/SearchTermParsingMetadata" } }, "searchPhrase": { "$ref": "#/components/schemas/SearchPhase" }, "spellCheck": { "type": "array", "items": { "type": "string" } } } }, "Price": { "type": "object", "properties": { "usage": { "type": "string" }, "description": { "type": "string" }, "currency": { "type": "string" }, "contractId": { "type": "string" }, "value": { "type": "string" } } }, "ProductDetail": { "type": "object", "properties": { "hasSingleSKU": { "type": "boolean" }, "buyable": { "type": "string" }, "resourceId": { "type": "string" }, "uniqueID": { "type": "integer", "format": "int64" }, "parentCatalogGroupID": { "type": "array", "items": { "type": "string" } }, "sellerId": { "type": "string" }, "name": { "type": "string" }, "shortDescription": { "type": "string" }, "manufacturer": { "type": "string" }, "longDescription": { "type": "string" }, "catalogEntryTypeCode": { "type": "string" }, "thumbnailRaw": { "type": "string" }, "thumbnail": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "parentCatalogEntryID": { "type": "string" }, "partNumber": { "type": "string" }, "storeID": { "type": "string" }, "fullImageRaw": { "type": "string" }, "fullImage": { "type": "string" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/Image" } }, "userData": { "type": "array", "items": { "$ref": "#/components/schemas/UserDataType" } }, "numberOfSKUs": { "type": "string" }, "disallowRecurringOrder": { "type": "integer", "format": "int32" }, "keyword": { "type": "string" }, "singleSKUCatalogEntryID": { "type": "string" }, "subscriptionTypeCode": { "type": "string" }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/Component" } }, "merchandisingAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/MerchandisingAssociation" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "sKUs": { "type": "array", "items": { "$ref": "#/components/schemas/SKU" } } } }, "ProductDetailArray": { "type": "object", "properties": { "catalogEntryView": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDetail" } }, "recordSetCount": { "type": "integer", "format": "int32" }, "recordSetTotal": { "type": "integer", "format": "int32" }, "recordSetTotalMatches": { "type": "integer", "format": "int32" }, "recordSetComplete": { "type": "string" }, "recordSetStartNumber": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string" }, "resourceId": { "type": "string" }, "metaData": { "$ref": "#/components/schemas/MetaData" } } }, "ProductContent": { "type": "object", "properties": { "hasSingleSKU": { "type": "boolean" }, "buyable": { "type": "string" }, "resourceId": { "type": "string" }, "uniqueID": { "type": "integer", "format": "int64" }, "parentCatalogGroupID": { "type": "array", "items": { "type": "string" } }, "sellerId": { "type": "string" }, "name": { "type": "string" }, "shortDescription": { "type": "string" }, "manufacturer": { "type": "string" }, "longDescription": { "type": "string" }, "catalogEntryTypeCode": { "type": "string" }, "thumbnailRaw": { "type": "string" }, "thumbnail": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "parentCatalogEntryID": { "type": "string" }, "partNumber": { "type": "string" }, "storeID": { "type": "string" }, "fullImageRaw": { "type": "string" }, "fullImage": { "type": "string" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/Image" } }, "userData": { "type": "array", "items": { "$ref": "#/components/schemas/UserDataType" } }, "numberOfSKUs": { "type": "string" }, "disallowRecurringOrder": { "type": "integer", "format": "int32" }, "keyword": { "type": "string" }, "singleSKUCatalogEntryID": { "type": "string" }, "subscriptionTypeCode": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SKU" } }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/Component" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "type": { "type": "string" }, "id": { "type": "string" }, "groupingProperties": { "$ref": "#/components/schemas/GroupingProperties" } } }, "ProductContentArray": { "type": "object", "properties": { "metaData": { "$ref": "#/components/schemas/MetaData" }, "breadCrumbTrailEntryView": { "type": "array", "items": { "$ref": "#/components/schemas/BreadCrumbTrailEntryView" } }, "contents": { "type": "array", "items": { "$ref": "#/components/schemas/ProductContent" } }, "facets": { "type": "array", "items": { "$ref": "#/components/schemas/FacetView" } }, "total": { "type": "integer", "format": "int32" } } }, "ProductSummaryArray": { "type": "object", "properties": { "catalogEntryView": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogEntryView" } }, "recordSetCount": { "type": "integer", "format": "int32" }, "recordSetTotal": { "type": "integer", "format": "int32" }, "recordSetTotalMatches": { "type": "integer", "format": "int32" }, "recordSetComplete": { "type": "string" }, "recordSetStartNumber": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string" }, "resourceId": { "type": "string" }, "facetView": { "type": "array", "items": { "$ref": "#/components/schemas/FacetView" } }, "metaData": { "$ref": "#/components/schemas/MetaData" }, "breadCrumbTrailEntryView": { "type": "array", "items": { "$ref": "#/components/schemas/BreadCrumbTrailEntryView" } }, "breadCrumbTrailEntryViewExtended": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BreadCrumbTrailEntryView" } } } }, "ProductSummaryWithGrouping": { "type": "object", "properties": { "hasSingleSKU": { "type": "boolean" }, "buyable": { "type": "string" }, "resourceId": { "type": "string" }, "uniqueID": { "type": "integer", "format": "int64" }, "parentCatalogGroupID": { "type": "array", "items": { "type": "string" } }, "sellerId": { "type": "string" }, "name": { "type": "string" }, "shortDescription": { "type": "string" }, "manufacturer": { "type": "string" }, "longDescription": { "type": "string" }, "catalogEntryTypeCode": { "type": "string" }, "thumbnailRaw": { "type": "string" }, "thumbnail": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "parentCatalogEntryID": { "type": "string" }, "partNumber": { "type": "string" }, "storeID": { "type": "string" }, "fullImageRaw": { "type": "string" }, "fullImage": { "type": "string" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/Image" } }, "userData": { "type": "array", "items": { "$ref": "#/components/schemas/UserDataType" } }, "numberOfSKUs": { "type": "string" }, "disallowRecurringOrder": { "type": "integer", "format": "int32" }, "keyword": { "type": "string" }, "singleSKUCatalogEntryID": { "type": "string" }, "subscriptionTypeCode": { "type": "string" }, "groupingProperties": { "$ref": "#/components/schemas/GroupingProperties" } } }, "ProductSummaryWithGroupingArray": { "type": "object", "properties": { "catalogEntryView": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSummaryWithGrouping" } }, "recordSetCount": { "type": "integer", "format": "int32" }, "recordSetTotal": { "type": "integer", "format": "int32" }, "recordSetTotalMatches": { "type": "integer", "format": "int32" }, "recordSetComplete": { "type": "string" }, "recordSetStartNumber": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string" }, "resourceId": { "type": "string" }, "facetView": { "type": "array", "items": { "$ref": "#/components/schemas/FacetView" } }, "metaData": { "$ref": "#/components/schemas/MetaData" } } }, "ProductSuggestion": { "type": "object", "properties": { "recordSetCount": { "type": "integer", "format": "int32" }, "recordSetTotal": { "type": "integer", "format": "int32" }, "recordSetComplete": { "type": "string" }, "recordSetTotalMatches": { "type": "number" }, "recordSetStartNumber": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string" }, "resourceId": { "type": "string" }, "metaData": { "type": "object", "properties": { "price": { "type": "string" } } }, "suggestionView": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSuggestionView" } } } }, "ProductSuggestionView": { "type": "object", "properties": { "identifier": { "type": "string" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/productSuggestionEntry" } } } }, "productSuggestionEntry": { "type": "object", "properties": { "hasSingleSKU": { "type": "boolean" }, "resourceId": { "type": "string" }, "uniqueID": { "type": "string" }, "thumbnailRaw": { "type": "string" }, "partNumber": { "type": "string" }, "shortDescription": { "type": "string" }, "thumbnail": { "type": "string" }, "catalogEntryTypeCode": { "type": "string" }, "storeID": { "type": "string" }, "price": { "type": "object", "properties": { "usage": { "type": "string" }, "contractId": { "type": "string" }, "description": { "type": "boolean" }, "currency": { "type": "string" }, "value": { "type": "string" } } }, "name": { "type": "string" }, "userData": { "$ref": "#/components/schemas/UserDataType" } } }, "Parent": { "type": "object", "properties": { "href": { "type": "string" } } }, "Page": { "type": "object", "properties": { "imageAlternateDescription": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "metaDescription": { "type": "string" }, "metaKeyword": { "type": "string" } } }, "Property": { "type": "object", "properties": { "emsName": { "type": "string" }, "populationChoice": { "type": "string" } } }, "Query": { "type": "object", "properties": { "params": { "type": "array", "items": { "type": "object", "properties": { "DynamicKitReturnPrice": { "type": "string" }, "nlpSupport": { "type": "string" }, "maxRows": { "type": "string" }, "searchType": { "type": "string" }, "maxTimeAllowed": { "type": "string" } } } }, "queryFields": { "type": "array", "items": { "type": "string" } }, "sortFields": { "type": "object", "properties": { "1": { "type": "string" }, "2": { "type": "string" }, "3": { "type": "string" }, "4": { "type": "string" } } }, "provider": { "type": "array", "items": { "type": "string" } }, "preprocessor": { "type": "array", "items": { "type": "string" } }, "postprocessor": { "type": "array", "items": { "type": "string" } }, "responseFields": { "type": "array", "items": { "type": "string" } }, "highlight": { "type": "object" }, "spellcheck": { "type": "object", "properties": { "limit": { "type": "string" } } }, "group": { "type": "object", "properties": { "enable": { "type": "string" }, "field": { "type": "string" }, "sort": { "type": "string" } } }, "hero": { "type": "object", "properties": { "overrideFieldName": { "type": "string" }, "showGroupPriceRange": { "type": "string" }, "useMerchandiseAttribute": { "type": "string" }, "field": { "type": "object" } } } } }, "ResourceHandler": { "type": "object", "properties": { "resourceName": { "type": "string" } } }, "Seo": { "type": "object", "properties": { "href": { "type": "string" } } }, "SKU": { "type": "object", "properties": { "hasSingleSKU": { "type": "boolean" }, "buyable": { "type": "string" }, "resourceId": { "type": "string" }, "uniqueID": { "type": "integer", "format": "int64" }, "shortDescription": { "type": "string" }, "parentCatalogGroupID": { "type": "array", "items": { "type": "string" } }, "catalogEntryTypeCode": { "type": "string" }, "thumbnailRaw": { "type": "string" }, "thumbnail": { "type": "string" }, "seo": { "$ref": "#/components/schemas/Seo" }, "partNumber": { "type": "string" }, "storeID": { "type": "integer", "format": "int32" }, "sellerID": { "type": "string" }, "name": { "type": "string" }, "manufacturer": { "type": "string" }, "longDescription": { "type": "string" }, "parentCatalogEntryID": { "type": "string" }, "fullImageRaw": { "type": "string" }, "fullImage": { "type": "string" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/Image" } } } }, "Self": { "type": "object", "properties": { "href": { "type": "string" } } }, "SearchPhase": { "type": "object", "properties": { "original": { "type": "string" }, "adjusted": { "type": "string" } } }, "SearchRuleParsingMetadata": { "type": "object", "properties": { "order": { "type": "string" }, "filter": { "type": "string" }, "boost": { "type": "string" }, "replaceTerm": { "type": "string" } } }, "SearchTermParsingMetadata": { "type": "object", "properties": { "searchTerm": { "type": "string" }, "excludeTerm": { "type": "string" }, "fallbackSearch": { "type": "string" }, "spellCorrect": { "type": "string" }, "stopword": { "type": "string" }, "sta": { "type": "string" }, "partNumber": { "type": "string" }, "searchRule": { "$ref": "#/components/schemas/SearchRuleParsingMetadata" }, "nlp": { "$ref": "#/components/schemas/NlpParsingMetadata" }, "customFields": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SearchProfile": { "type": "object", "properties": { "parentProfileName": { "type": "string" }, "lookupProfileName": { "type": "string" }, "lookupProfileNames": { "type": "object", "properties": { "productSKU": { "type": "string" }, "variantSKU": { "type": "string" }, "component": { "type": "string" }, "merchandisingAssoc": { "type": "string" } }, "x-introduced": "9.1.13.2", "description": "This field is used to define lookup profile name to fetch the product sku/ variant sku/ component/ merchandising association details for the product. This is supported starting from v9.1.13.2." }, "profileName": { "type": "string" }, "indexName": { "type": "string" }, "query": { "$ref": "#/components/schemas/Query" } } }, "SearchRankingName": { "type": "object", "properties": { "id": { "type": "string" }, "modified": { "type": "string" } } }, "SearchRankingNameCollection": { "type": "object", "properties": { "contents": { "type": "array", "items": { "$ref": "#/components/schemas/SearchRankingName" } } } }, "SearchRanking": { "type": "object", "properties": { "id": { "type": "string" }, "modified": { "type": "string" }, "storeId": { "type": "integer", "format": "int32" }, "languageId": { "type": "integer", "format": "int32" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/SearchRankingAction" } } } }, "SearchRankingAction": { "type": "object", "properties": { "catalogEntryId": { "type": "string" }, "referenceCatalogEntryId": { "type": "string" }, "position": { "type": "integer", "format": "int32" }, "pin": { "type": "boolean" }, "add": { "type": "boolean" }, "hide": { "type": "boolean" } } }, "Slot": { "type": "object", "properties": { "id": { "type": "string" }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/Widget" } } } }, "UserDataType": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" } }, "value": { "type": "array", "items": { "type": "string" } } } }, "UrlContent": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/Layout" }, "identifier": { "type": "string" }, "storeType": { "type": "string" }, "tokenName": { "type": "string" }, "tokenExternalValue": { "type": "string" }, "language": { "type": "string" }, "id": { "type": "string" }, "page": { "$ref": "#/components/schemas/Page" }, "storeId": { "type": "string" }, "tokenValue": { "type": "string" }, "status": { "type": "integer", "format": "int32" } } }, "UrlContentArray": { "type": "object", "properties": { "contents": { "type": "array", "items": { "$ref": "#/components/schemas/UrlContent" } } } }, "Widget": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "widgetName": { "type": "string" }, "sequence": { "type": "number", "format": "double" }, "properties": { "$ref": "#/components/schemas/Property" } } }, "AttributeValueItem": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "AttributeValueBooleanItem": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "boolean" } } ] } } } }