{ "openapi": "3.0.1", "info": { "title": "Catalog Filters", "version": "9.1.20.0", "description": "Create and administer catalog filters.", "x-introduced": "9.1.0.0" }, "servers": [ { "url": "https://{hostname}:{port}/rest/admin/v2", "variables": { "port": { "default": "443", "enum": [ "443", "8000" ] }, "hostname": { "default": "localhost", "enum": [ "localhost", "test.hcl.com" ] } } } ], "tags": [ { "name": "Catalog Filters", "description": "This class provides RESTful services to manage catalog filters." } ], "paths": { "/catalog-filters": { "get": { "summary": "Get a collection of catalog filters.", "operationId": "getCatalogFilters", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "getCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogFilterType", "x-expression-template": "{_wcf.ap='IBM_CatalogFilter_details';_wcf.dataLanguageIds='{}'}/CatalogFilter", "parameters": [ { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "searchString", "in": "query", "description": "The search string used to search for catalog filters.", "schema": { "type": "string" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFilterCollection" } } } } } }, "post": { "summary": "Create a catalog filter.", "operationId": "createCatalogFilter", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "processCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ProcessCatalogFilterType", "x-action-code": "Create", "x-expression-template": "/CatalogFilter[1]", "parameters": [ { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/externalIdentifier/storeIdentifier/uniqueID", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFilterRequest" } } } }, "responses": { "201": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "headers": { "Location": { "description": "The URI of catalog filter.", "schema": { "type": "string" } } }, "links": { "GetCatalogFiltersByIdAndStoreId": { "operationRef": "#/paths/~1catalog-filters~1{id}/get", "parameters": { "id": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `id` and `storeId` value used in the request body can be used as the `id` and `storeId` parameter in `GET /catalog-filters/{id}`.\n" }, "DeleteCatalogFiltersByIdAndStoreId": { "operationRef": "#/paths/~1catalog-filters~1{id}/delete", "parameters": { "id": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `id` and `storeId` value used in the request body can be used as the `id` and `storeId` parameter in `DELETE /catalog-filters/{id}`.\n" }, "UpdateCatalogFiltersByIdAndStoreId": { "operationRef": "#/paths/~1catalog-filters~1{id}/patch", "parameters": { "id": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `id` and `storeId` value used in the request body can be used as the `id` and `storeId` parameter in `PATCH /catalog-filters/{id}`.\n" }, "CreateCatalogFiltersByIdAndStoreId": { "operationRef": "#/paths/~1catalog-filters~1{id}~1category-selections/post", "parameters": { "id": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `id` and `storeId` value used in the request body can be used as the `id` and `storeId` parameter in `POST /catalog-filters/{id}/category-selections`.\n" }, "CreateCatalogEntriesByCatalogFilterIdAndStoreId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1catalog-entry-selections/post", "parameters": { "catalogFilterId": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId` and `storeId` value used in the request body can be used as the `catalogFilterId` and `storeId` parameter in `POST /catalog-filters/{catalogFilterId}/catalog-entry-selections`.\n" } } } } } }, "/catalog-filters/by-name": { "get": { "summary": "Get catalog filters based on the name of the catalog filter.", "operationId": "getCatalogFiltersByName", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "getCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogFilterType", "x-expression-builder-class": "com.ibm.commerce.foundation.internal.client.taglib.util.SearchExpressionBuilder", "x-parameters": { "accessProfile": "IBM_Admin_Summary", "template": "/CatalogFilter[search(CatalogFilterIdentifier/ExternalIdentifier/Identifier='$name$')]" }, "parameters": [ { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "description": "The catalog filter name.", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFilterCollection" } } } } } } }, "/catalog-filters/{id}": { "get": { "summary": "Get a specific catalog filter based on the ID of the catalog filter.", "operationId": "getCatalogFilterById", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "getCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogFilterType", "x-expression-template": "{_wcf.ap='IBM_CatalogFilter_details';_wcf.dataLanguageIds='{}'}/CatalogFilter[CatalogFilterIdentifier[(UniqueID='{id}')]]", "parameters": [ { "name": "id", "description": "The unique numeric ID for identifying the catalog filter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFilter" } } } } } }, "patch": { "summary": "Update a specific catalog filter based on the ID of the catalog filter.", "operationId": "updateCatalogFilter", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-action-code": "Change", "x-expression-template": "/CatalogFilter[1]", "parameters": [ { "name": "id", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/externalIdentifier/storeIdentifier/uniqueID", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFilterRequest" } } } }, "responses": { "200": { "description": "The operation is successful." } } }, "delete": { "summary": "Delete a specific catalog filter based on the ID of catalog filter.", "operationId": "deleteCatalogFilter", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "processCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ProcessCatalogFilterType", "x-action-code": "Delete", "x-expression-template": "/CatalogFilter[1]", "parameters": [ { "name": "id", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/externalIdentifier/storeIdentifier/uniqueID", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The operation is successful." } } } }, "/catalog-filters/{catalogFilterId}/category-selections": { "get": { "summary": "Get a collection of a catalog filter's category selections based on the ID of the catalog filter.", "operationId": "getCatalogFilterCategorySelections", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "getCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogFilterType", "x-expression-template": "{_wcf.ap='IBM_CatalogFilter_Details_WithoutCatentries';_wcf.dataLanguageIds='{}'}/CatalogFilter[CatalogFilterIdentifier[(UniqueID='{catalogFilterId}')]]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorySelectionCollection" } } } } } }, "post": { "summary": "Create a catalog filter category selection.", "operationId": "createCatalogFilterCategorySelection", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-action-code": "Add", "x-request-verb": "change", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorySelection" } } } }, "responses": { "201": { "description": "The operation is successful", "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/catalogGroupSelectionIdentifier/uniqueID", "headers": { "Location": { "description": "The URI of catalog filter category element selection.", "schema": { "type": "string" } } }, "links": { "DeleteCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1{catalogGroupSelectionId}~1category-selections~1{catalogGroupSelectionId}/delete", "parameters": { "catalogFilterId": "$request.body#/catalogFilterId", "catalogGroupSelectionId": "$request.body#/catalogGroupSelectionId", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId` and `catalogGroupSelectionId` value used in the request body can be used as the `catalogFilterId` `catalogGroupSelectionId` parameter in `DELETE /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}`.\n" }, "UpdateCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1{catalogGroupSelectionId}~1category-selections~1{catalogGroupSelectionId}/patch", "parameters": { "catalogFilterId": "$request.body#/catalogFilterId", "catalogGroupSelectionId": "$request.body#/catalogGroupSelectionId", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId` and `catalogGroupSelectionId` value used in the request body can be used as the `catalogFilterId` `catalogGroupSelectionId` parameter in `PATCH /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}`.\n" }, "GetCategorySelectionsByCatalogFilterIdAndStoreId": { "operationRef": "#/paths/~1catalog-filters~1{id}~1category-selections/get", "parameters": { "id": "$request.path.id", "storeId": "$request.query.storeId" }, "description": "The `id` , `storeId` value used in the request body can be used as the `id`, `storeId` parameter in `GET /catalog-filters/{id}/category-selections`.\n" }, "CreateConditionGroupsByCatalogFilterIdAndCatalogGroupSelectionIdAndStoreId": { "operationRef": "#/paths/~1catalog-filters~1{id}~1category-selections/post", "parameters": { "catalogGroupSelectionId": "$request.body#/catalogGroupSelectionId", "catalogFilterId": "$request.body#/catalogFilterId", "storeId": "$request.query.storeId" }, "description": "The `catalogGroupSelectionId` , `catalogFilterId` and `storeId` value used in the request body can be used as the `catalogGroupSelectionId`, `catalogFilterId` and `storeId` parameter in `POST /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}/condition-groups`.\n" } } } } } }, "/catalog-filters/{catalogFilterId}/category-selections/{id}": { "patch": { "summary": "Update a specific catalog filter category element selection based on the ID of the catergory selection.", "operationId": "updateCatalogFilterCategorySelection", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-action-code": "Update", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "id", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorySelection" } } } }, "responses": { "200": { "description": "The operation is successful." } } }, "delete": { "summary": "Delete a specific catalog filter category element selection based on the ID of the category selection.", "operationId": "deleteCatalogFilterCategorySelection", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Delete", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "id", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The operation is successful." } } } }, "/catalog-filters/{catalogFilterId}/category-selections/{categorySelectionId}/condition-groups": { "post": { "summary": "Create a specific catalog filter's category group condition based on the ID of the category selection.", "operationId": "createCatalogFilterCategorySelectionConditionGroup", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-action-code": "Add", "x-request-verb": "change", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]/ConditionGroup[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "categorySelectionId", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/conditionGroupIdentifier/externalIdentifier/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConditionGroupRequest" } } } }, "responses": { "201": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/conditionGroupIdentifier/uniqueID", "headers": { "Location": { "description": "The URI of catalog filter category group condition.", "schema": { "type": "string" } } }, "links": { "DeleteCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionIdAndconditionGroupIdAndstoreId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1category-selections~1{catalogGroupSelectionId}~1condition-groups~1{conditionGroupId}/delete", "parameters": { "catalogFilterId": "$request.path.catalogFilterId", "catalogGroupSelectionId": "$request.path.catalogGroupSelectionId", "conditionGroupId": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId`, `catalogGroupSelectionId` and `conditionGroupId` value used in the request body can be used as the `catalogFilterId` ,`catalogGroupSelectionId` and `conditionGroupId` parameter in `DELETE /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}/condition-groups/{conditionGroupId}`.\n" }, "UpdateCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionIdAndconditionGroupIdAndstoreId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1category-selections~1{catalogGroupSelectionId}~1condition-groups~1{conditionGroupId}/patch", "parameters": { "catalogFilterId": "$request.path.catalogFilterId", "catalogGroupSelectionId": "$request.path.catalogGroupSelectionId", "conditionGroupId": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId`, `catalogGroupSelectionId` and `conditionGroupId` value used in the request body can be used as the `catalogFilterId` ,`catalogGroupSelectionId` and `conditionGroupId` parameter in `PATCH /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}/condition-groups/{conditionGroupId}`.\n" }, "CreateCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionIdAndconditionGroupIdAndstoreId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1category-selections~1{catalogGroupSelectionId}~1condition-groups~1{conditionGroupId}~1attributes/post", "parameters": { "catalogFilterId": "$request.path.catalogFilterId", "catalogGroupSelectionId": "$request.path.catalogGroupSelectionId", "conditionGroupId": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId`, `catalogGroupSelectionId` and `conditionGroupId` and `storeId` value used in the request body can be used as the `catalogFilterId` ,`catalogGroupSelectionId` and `conditionGroupId` , `storeId` parameter in `POST /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}/condition-groups/{conditionGroupId}/attributes`.\n" } } } } } }, "/catalog-filters/{catalogFilterId}/category-selections/{categorySelectionId}/condition-groups/{id}": { "patch": { "summary": "Update a specific catalog filter's category group condition based on the ID of the condition group.", "operationId": "updateCatalogFilterCategorySelectionConditionGroup", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Update", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]/ConditionGroup[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "categorySelectionId", "description": "The unique numeric ID for identifying the catalog group selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/conditionGroupIdentifier/externalIdentifier/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "id", "description": "The unique numeric ID for identifying the condition group.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/conditionGroupIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConditionGroupRequest" } } } }, "responses": { "200": { "description": "The operation is successful." } } }, "delete": { "summary": "Delete a specific catalog filter's category group condition based on the ID of the condition group.", "operationId": "deleteCatalogFilterCategorySelectionConditionGroup", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Delete", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]/ConditionGroup[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "categorySelectionId", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/conditionGroupIdentifier/externalIdentifier/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "id", "description": "The unique numeric ID for identifying the condition group.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/conditionGroupIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The store id.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The operation is successful." } } } }, "/catalog-filters/{catalogFilterId}/category-selections/{categorySelectionId}/condition-groups/{conditionGroupId}/conditions": { "post": { "summary": "Create a catalog filter category selection condition group condition.", "operationId": "createCatalogFilterCategorySelectionConditionGroupCondition", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Add", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]/ConditionGroup[1]/Condition[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "categorySelectionId", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/conditionGroupIdentifier/externalIdentifier/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "conditionGroupId", "description": "The unique numeric ID for identifying the condition group.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionIdentifier/externalIdentifier/catalogFilterConditionGroupIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConditionRequest" } } } }, "responses": { "201": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionIdentifier/uniqueID", "headers": { "Location": { "description": "The URI of catalog filter category selection condition group condition.", "schema": { "type": "string" } } }, "links": { "DeleteCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionIdAndconditionGroupIdAndConditionId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1category-selections~1{catalogGroupSelectionId}~1condition-groups~1{conditionGroupId}~1attributes~1{conditionId}/delete", "parameters": { "catalogFilterId": "$request.path.catalogFilterId", "catalogGroupSelectionId": "$request.path.catalogGroupSelectionId", "conditionGroupId": "$request.path.conditionGroupId", "conditionId": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId`, `catalogGroupSelectionId` and `conditionGroupId` , `conditionId` value used in the request body can be used as the `catalogFilterId` ,`catalogGroupSelectionId` and `conditionGroupId` , `conditionId` parameter in `DELETE /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}/condition-groups/{conditionGroupId}/attributes/{conditionId}`.\n" }, "UpdateCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionIdAndconditionGroupIdAndConditionId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1category-selections~1{catalogGroupSelectionId}~1condition-groups~1{conditionGroupId}~1attributes~1{conditionId}/patch", "parameters": { "catalogFilterId": "$request.path.catalogFilterId", "catalogGroupSelectionId": "$request.path.catalogGroupSelectionId", "conditionGroupId": "$request.path.conditionGroupId", "conditionId": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId`, `catalogGroupSelectionId` and `conditionGroupId` , `conditionId` value used in the request body can be used as the `catalogFilterId` ,`catalogGroupSelectionId` and `conditionGroupId` , `conditionId` parameter in `PATCH /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}/condition-groups/{conditionGroupId}/attributes/{conditionId}`.\n" }, "CreateCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionIdAndconditionGroupIdAndConditionId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1category-selections~1{catalogGroupSelectionId}~1condition-groups~1{conditionGroupId}~1attributes~1{conditionId}~1attribute-values/post", "parameters": { "catalogFilterId": "$request.path.catalogFilterId", "catalogGroupSelectionId": "$request.path.catalogGroupSelectionId", "conditionGroupId": "$request.path.conditionGroupId", "conditionId": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId`, `catalogGroupSelectionId` and `conditionGroupId` , `conditionId` value used in the request body can be used as the `catalogFilterId` ,`catalogGroupSelectionId` and `conditionGroupId` , `conditionId` parameter in `POST /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}/condition-groups/{conditionGroupId}/attributes/{conditionId}/attribute-values`.\n" } } } } } }, "/catalog-filters/{catalogFilterId}/category-selections/{categorySelectionId}/condition-groups/{conditionGroupId}/conditions/{id}": { "patch": { "summary": "Update a specific catalog filter category selection condition group condition.", "operationId": "updateCatalogFilterCategorySelectionConditionGroupCondition", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Update", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]/ConditionGroup[1]/Condition[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "categorySelectionId", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/conditionGroupIdentifier/externalIdentifier/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "conditionGroupId", "description": "The unique numeric ID for identifying the condition group.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionIdentifier/externalIdentifier/catalogFilterConditionGroupIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "id", "description": "The unique numeric ID for identifying the condition.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConditionRequest" } } } }, "responses": { "200": { "description": "The operation is successful." } } }, "delete": { "summary": "Delete a specific catalog filter category selection condition group condition.", "operationId": "deleteCatalogFilterCategorySelectionConditionGroupCondition", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Delete", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]/ConditionGroup[1]/Condition[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "categorySelectionId", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/conditionGroupIdentifier/externalIdentifier/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "conditionGroupId", "description": "The unique numeric ID for identifying the condition group.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionIdentifier/externalIdentifier/catalogFilterConditionGroupIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "id", "description": "The unique numeric ID for identifying the condition.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The operation is successful." } } } }, "/catalog-filters/{catalogFilterId}/category-selections/{categorySelectionId}/condition-groups/{conditionGroupId}/conditions/{conditionId}/values": { "post": { "summary": "Create a catalog filter category selection condition group condition value.", "operationId": "createCatalogFilterCategorySelectionConditionGroupConditionValue", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Add", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]/ConditionGroup[1]/Condition[1]/ConditionAttributeValue[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "categorySelectionId", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "conditionGroupId", "description": "The unique numeric ID for identifying the condition group.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionIdentifier/externalIdentifier/catalogFilterConditionGroupIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "conditionId", "in": "path", "description": "The condition attribute ID.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionAttributeValue[1]/conditionValueIdentifier/externalIdentifier/catalogFilterConditionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/externalIdentifier/storeIdentifier/uniqueID", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionAttributeValue[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConditionValueRequest" } } } }, "responses": { "201": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionAttributeValue[1]/conditionValueIdentifier/uniqueID", "headers": { "Location": { "description": "The URI of catalog filter category group condition attribute value.", "schema": { "type": "string" } } }, "links": { "DeleteCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionIdAndconditionGroupIdAndConditionIdAndConditionAttributeValueId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1category-selections~1{catalogGroupSelectionId}~1condition-groups~1{conditionGroupId}~1attributes~1{conditionId}~1attribute-values~1{conditionAttributeValueId}/delete", "parameters": { "catalogFilterId": "$request.path.catalogFilterId", "catalogGroupSelectionId": "$request.path.catalogGroupSelectionId", "conditionGroupId": "$request.path.conditionGroupId", "conditionId": "$request.path.conditionId", "conditionAttributeValueId": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId`, `catalogGroupSelectionId` and `conditionGroupId` , `conditionId` , `conditionAttributeValueId` value used in the request body can be used as the `catalogFilterId` ,`catalogGroupSelectionId` and `conditionGroupId` , `conditionId`, `conditionAttributeValueId` parameter in `DELETE /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}/condition-groups/{conditionGroupId}/attributes/{conditionId}/attribute-values/{conditionAttributeValueId}`.\n" }, "UpdateCatalogFiltersByCatalogFilterIdAndCatalogGroupSelectionIdAndconditionGroupIdAndConditionIdAndConditionAttributeValueId": { "operationRef": "#/paths/~1catalog-filters~1{catalogFilterId}~1category-selections~1{catalogGroupSelectionId}~1condition-groups~1{conditionGroupId}~1attributes~1{conditionId}~1attribute-values~1{conditionAttributeValueId}/patch", "parameters": { "catalogFilterId": "$request.path.catalogFilterId", "catalogGroupSelectionId": "$request.path.catalogGroupSelectionId", "conditionGroupId": "$request.path.conditionGroupId", "conditionId": "$request.path.conditionId", "conditionAttributeValueId": "$response.header.Location", "storeId": "$request.query.storeId" }, "description": "The `catalogFilterId`, `catalogGroupSelectionId` and `conditionGroupId` , `conditionId` , `conditionAttributeValueId` value used in the request body can be used as the `catalogFilterId` ,`catalogGroupSelectionId` and `conditionGroupId` , `conditionId`, `conditionAttributeValueId` parameter in `PATCH /catalog-filters/{catalogFilterId}/category-selections/{catalogGroupSelectionId}/condition-groups/{conditionGroupId}/attributes/{conditionId}/attribute-values/{conditionAttributeValueId}`.\n" } } } } } }, "/catalog-filters/{catalogFilterId}/category-selections/{categorySelectionId}/condition-groups/{conditionGroupId}/attributes/{conditionId}/values/{id}": { "patch": { "summary": "Update a catalog filter category selection condition group condition value.", "operationId": "updateCatalogFilterCategorySelectionConditionGroupConditionValue", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Update", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]/ConditionGroup[1]/Condition[1]/ConditionAttributeValue[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "categorySelectionId", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "conditionGroupId", "description": "The unique numeric ID for identifying the condition group.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionIdentifier/externalIdentifier/catalogFilterConditionGroupIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "conditionId", "description": "The unique numeric ID for identifying the condition.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionAttributeValue[1]/conditionValueIdentifier/externalIdentifier/catalogFilterConditionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "id", "description": "The unique numeric ID for identifying the condition value.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionAttributeValue[1]/conditionValueIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/externalIdentifier/storeIdentifier/uniqueID", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionAttributeValue[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConditionValueRequest" } } } }, "responses": { "200": { "description": "The operation is successful." } } }, "delete": { "summary": "Delete a catalog filter category selection condition group condition value.", "operationId": "deleteCatalogFilterCategorySelectionConditionGroupConditionValue", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Delete", "x-expression-template": "/CatalogFilter[1]/CatalogGroupSelection[1]/ConditionGroup[1]/Condition[1]/ConditionAttributeValue[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "categorySelectionId", "description": "The unique numeric ID for identifying the category selection.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/catalogGroupSelectionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "conditionGroupId", "description": "The unique numeric ID for identifying the condition group.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionIdentifier/externalIdentifier/catalogFilterConditionGroupIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "conditionId", "description": "The unique numeric ID for identifying the condition.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionAttributeValue[1]/conditionValueIdentifier/externalIdentifier/catalogFilterConditionIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "id", "description": "The unique numeric ID for identifying the condition value.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogGroupSelection[1]/conditionGroup[1]/condition[1]/conditionAttributeValue[1]/conditionValueIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/externalIdentifier/storeIdentifier/uniqueID", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The operation is successful." } } } }, "/catalog-filters/{catalogFilterId}/catalog-entry-selections": { "get": { "summary": "Get the collection of a catalog filter's catalog entry selections based on the ID of the catalog filter.", "operationId": "getCatalogFilterCatalogEntrySelections", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "getCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogFilterType", "x-expression-template": "{_wcf.ap='IBM_CatalogFilter_details';_wcf.dataLanguageIds='{}'}/CatalogFilter[CatalogFilterIdentifier[UniqueID={catalogFilterId}] and ProductSetSelection[@selection='{selection}']]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "schema": { "type": "integer", "format": "int32" } }, { "name": "selection", "description": "Selection type. Catalog entry selections are either Include or Exclude.", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "Include", "Exclude" ] } }, { "name": "offset", "description": "The offset.", "in": "query", "required": false, "x-entity-path": "dataArea/get/recordSetStartNumber", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "description": "The limit.", "in": "query", "required": false, "x-entity-path": "dataArea/get/maxItems", "schema": { "type": "integer", "format": "int32", "default": 25 } } ], "responses": { "200": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter[1]/productSetSelection[1]/productSet/catalogEntryIdentifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogEntrySelectionCollection" } } } } } }, "post": { "summary": "Create a catalog filter's catalog entry selection based on the ID of the catalog filter.", "operationId": "createCatalogFilterCatalogEntrySelection", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-expression-template": "/CatalogFilter[1]/ProductSetSelection[1]", "x-request-verb": "change", "x-action-code": "Add", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/externalIdentifier/storeIdentifier/uniqueID", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/productSetSelection[1]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCatalogEntrySelection" } } } }, "responses": { "201": { "description": "The operation is successful.", "x-entity-path": "dataArea/catalogFilter[1]/productSetSelection[1]/productSet/catalogEntryIdentifier[1]/uniqueID", "headers": { "Location": { "description": "The URI of catalog filter.", "schema": { "type": "string" } } } } } } }, "/catalog-filters/{catalogFilterId}/catalog-entry-selections/{id}": { "delete": { "summary": "Delete a specific catalog filter's catalog entry selection based on the ID of the catalog entry.", "operationId": "deleteCatalogFilterCatalogEntrySelection", "tags": [ "Catalog Filters" ], "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient", "x-facade-client-method": "changeCatalogFilter", "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogFilterType", "x-request-verb": "change", "x-action-code": "Delete", "x-expression-template": "/CatalogFilter[1]/ProductSetSelection[1]", "parameters": [ { "name": "catalogFilterId", "description": "The unique numeric ID for identifying the catalog filter.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/uniqueID", "schema": { "type": "string" } }, { "name": "storeId", "description": "The unique numeric ID for identifying the store.", "in": "query", "required": true, "x-context-data": "storeId", "x-entity-path": "dataArea/catalogFilter[1]/catalogFilterIdentifier/externalIdentifier/storeIdentifier/uniqueID", "schema": { "type": "integer", "format": "int32" } }, { "name": "selection", "description": "The selection of catalog entry ID.", "in": "query", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/productSetSelection[1]/selection", "schema": { "type": "string", "enum": [ "Include", "Exclude" ] } }, { "name": "id", "description": "The catalog entry ID.", "in": "path", "required": true, "x-entity-path": "dataArea/catalogFilter[1]/productSetSelection[1]/productSet/catalogEntryIdentifier[1]/uniqueID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The operation is successful." } } } } }, "components": { "schemas": { "CatalogFilterCollection": { "description": "The collection of catalog filters.", "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFilter" } } } }, "CatalogFilter": { "type": "object", "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogFilterType", "properties": { "id": { "type": "string", "x-entity-path": "catalogFilterIdentifier/uniqueID" }, "name": { "type": "string", "x-entity-path": "catalogFilterIdentifier/externalIdentifier/identifier", "description": "Required when creating a catalog filter" }, "storeId": { "type": "integer", "format": "int32", "x-entity-path": "catalogFilterIdentifier/externalIdentifier/storeIdentifier/uniqueID" }, "catalogId": { "type": "string", "x-entity-path": "catalogFilterIdentifier/externalIdentifier/catalogIdentifier/uniqueID" }, "description": { "type": "string", "x-entity-path": "description[1]/value", "description": "Optionally required when creating a catalog filter." }, "usage": { "type": "string" } } }, "CatalogFilterRequest": { "type": "object", "properties": { "catalogId": { "type": "string", "x-entity-path": "catalogFilterIdentifier/externalIdentifier/catalogIdentifier/uniqueID" }, "description": { "type": "string", "description": "Optionally required when creating a catalog filter.", "x-entity-path": "description[1]/value" }, "name": { "type": "string", "description": "Required when creating a catalog filter", "x-entity-path": "catalogFilterIdentifier/externalIdentifier/identifier" }, "usage": { "type": "string" } }, "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogFilterType" }, "CatalogEntrySelectionCollection": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogEntrySelection" } } } }, "CatalogEntrySelection": { "description": "Catalog entry selection", "type": "object", "x-entity-class": "com.ibm.commerce.foundation.common.datatypes.CatalogEntryIdentifierType", "properties": { "selection": { "type": "string", "x-entity-path": "container/container/selection" }, "id": { "type": "string", "x-entity-path": "uniqueID" } } }, "CreateCatalogEntrySelection": { "description": "Catalog entry selection", "type": "object", "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.ProductSetSelectionType", "properties": { "selection": { "type": "string", "x-entity-path": "selection" }, "id": { "type": "string", "x-entity-path": "productSet/catalogEntryIdentifier[1]/uniqueID" } } }, "CategorySelectionCollection": { "type": "object", "properties": { "items": { "type": "array", "x-entity-path": "catalogGroupSelection", "items": { "$ref": "#/components/schemas/CategorySelection" } } } }, "CategorySelection": { "description": "A category element selection.", "type": "object", "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogGroupSelectionType", "properties": { "selection": { "type": "string" }, "id": { "type": "string", "x-entity-path": "catalogGroupSelectionIdentifier/uniqueID" }, "catalogFilterId": { "type": "string", "x-entity-path": "catalogGroupSelectionIdentifier/externalIdentifier/catalogFilterIdentifier/uniqueID" }, "catalogGroupId": { "type": "string", "x-entity-path": "catalogGroupSelectionIdentifier/externalIdentifier/catalogGroupIdentifier/uniqueID" }, "conditionGroups": { "type": "array", "x-entity-path": "conditionGroup", "items": { "$ref": "#/components/schemas/ConditionGroup" } } } }, "ConditionGroup": { "description": "A condition group of category element selection.", "type": "object", "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogFilterConditionGroupType", "properties": { "conditionRelation": { "type": "string" }, "id": { "type": "string", "x-entity-path": "conditionGroupIdentifier/uniqueID" }, "categorySelectionId": { "type": "string", "x-entity-path": "conditionGroupIdentifier/externalIdentifier/catalogGroupSelectionIdentifier/uniqueID" }, "conditionName": { "type": "string", "x-entity-path": "conditionGroupIdentifier/externalIdentifier/identifier" }, "conditions": { "type": "array", "x-entity-path": "condition", "items": { "$ref": "#/components/schemas/Condition" } } } }, "ConditionGroupRequest": { "description": "A condition group of category element selection.", "type": "object", "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogFilterConditionGroupType", "properties": { "conditionRelation": { "type": "string" }, "conditionName": { "type": "string", "x-entity-path": "conditionGroupIdentifier/externalIdentifier/identifier" } } }, "Condition": { "description": "A condition group condition.", "type": "object", "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogFilterConditionType", "properties": { "id": { "type": "string", "x-entity-path": "conditionIdentifier/uniqueID" }, "conditionType": { "type": "integer", "format": "int32" }, "conditionGroupId": { "type": "string", "x-entity-path": "conditionIdentifier/externalIdentifier/catalogFilterConditionGroupIdentifier/uniqueID" }, "propertyName": { "type": "string", "x-entity-path": "conditionAttributeIdentifier/externalIdentifier/identifier" }, "attributeId": { "type": "string", "x-entity-path": "conditionAttributeIdentifier/uniqueID" }, "conditionOperator": { "type": "string" }, "values": { "type": "array", "x-entity-path": "conditionAttributeValue", "items": { "$ref": "#/components/schemas/ConditionValue" } } } }, "ConditionRequest": { "description": "A condition group condition.", "type": "object", "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogFilterConditionType", "properties": { "conditionType": { "type": "integer", "format": "int32" }, "propertyName": { "type": "string", "x-entity-path": "conditionAttributeIdentifier/externalIdentifier/identifier" }, "attributeId": { "type": "string", "x-entity-path": "conditionAttributeIdentifier/uniqueID" }, "conditionOperator": { "type": "string" } } }, "ConditionValue": { "description": "The value of a condition group condition.", "type": "object", "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogFilterConditionValueType", "properties": { "id": { "type": "string", "x-entity-path": "conditionValueIdentifier/uniqueID" }, "attributeValueId": { "type": "string", "x-entity-path": "identifier" }, "stringValue": { "type": "string", "x-entity-path": "stringValue/value" }, "integerValue": { "type": "integer", "format": "int32", "x-entity-path": "integerValue/value" }, "floatValue": { "type": "number", "format": "float", "x-entity-path": "floatValue/value" } } }, "ConditionValueRequest": { "description": "The value of a condition group condition.", "type": "object", "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogFilterConditionValueType", "properties": { "attributeValueId": { "type": "string", "x-entity-path": "identifier" }, "stringValue": { "type": "string", "x-entity-path": "stringValue/value" }, "integerValue": { "type": "integer", "format": "int32", "x-entity-path": "integerValue/value" }, "floatValue": { "type": "number", "format": "float", "x-entity-path": "floatValue/value" } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "x-components": {} }