REST API for Oracle Commerce Cloud December 2017

listFilters

get

/ccadmin/v1/responseFilters

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

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listFilters_response

Properties

items: Type: array items

Additional Properties Allowed:

List of all filters.

Nested Schema : items

Type: array

List of all filters.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

exclude: Type: string

The fields to exclude from the endpoint response.
include: Type: string

The fields to include in the endpoint response.
key: Type: string

The filterKey for the filter object retrieved.

Example 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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{"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"
  }
]}