createFilter

post

/ccadmin/v1/responseFilters

Create Filter. Create the filter object, that can be used to filter the endpoint response. Though both include and exclude are not mandatory, atleast one of them should be populated with data.

Request

Supported Media Types
Body ()
Root Schema : createFilter_request
Type: object
Show Source
Example:
{
    "include":"id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
    "exclude":"childSKUs.unitOfMeasure",
    "key":"productData"
}
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : createFilter_response
Type: object
Show Source
Example Response (application/json)
{
    "include":"id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
    "exclude":"childSKUs.unitOfMeasure",
    "key":"productData"
}

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| |------------------|------------------| |18005|FilterKey is mandatory.| |18006|Required Data not found to create the filter.| |18000|Unable to create filter for the key, because it already exist.| |18001|A problem occurred when saving the data.|
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