Jump to

• Request
• Response

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

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listFilters_response

Type: object

Show Source

• items(optional): array items
  List of all filters.

{
    "properties":{
        "items":{
            "description":"List of all filters.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "include":{
                        "description":"The fields to include in the endpoint response.",
                        "type":"string"
                    },
                    "exclude":{
                        "description":"The fields to exclude from the endpoint response.",
                        "type":"string"
                    },
                    "key":{
                        "description":"The filterKey for the filter object retrieved.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of all filters.

Show Source

• Array of: object items

{
    "description":"List of all filters.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "include":{
                "description":"The fields to include in the endpoint response.",
                "type":"string"
            },
            "exclude":{
                "description":"The fields to exclude from the endpoint response.",
                "type":"string"
            },
            "key":{
                "description":"The filterKey for the filter object retrieved.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• exclude(optional): string
  The fields to exclude from the endpoint response.
• include(optional): string
  The fields to include in the endpoint response.
• key(optional): string
  The filterKey for the filter object retrieved.

{
    "type":"object",
    "properties":{
        "include":{
            "description":"The fields to include in the endpoint response.",
            "type":"string"
        },
        "exclude":{
            "description":"The fields to exclude from the endpoint response.",
            "type":"string"
        },
        "key":{
            "description":"The filterKey for the filter object retrieved.",
            "type":"string"
        }
    }
}

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

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top