listFilters

get

/ccadmin/v1/responseFilters

List Filters. Gets all the filters defined by the merchant.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listFilters_response
Type: object
Show Source
Nested Schema : items
Type: array
List of all filters.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "items":[
        {
            "include":"id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
            "exclude":"childSKUs.unitOfMeasure",
            "key":"productData"
        },
        {
            "include":"category.displayName,items.id,items.productVariantOptions,items.displayName,items.route,items.primarySmallImageURL,items.primageImageAltText,items.primaryImageTitle,items.childSKUs.listPrice,items.childSKUs.salePrice,items.listPrice,items.salePrice,items.relatedProducts,items.description,items.relatedProducts",
            "key":"collectionData"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |18003|No filter exists for the site.| |18004|Unable to retrieve data for the filter.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top