Jump to

• Request
• Response

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

• application/json

Body ()

Root Schema : createFilter_request

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: string
  The filterKey for the filter to create.

{
    "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 to create.",
            "type":"string"
        }
    },
    "required":[
        "key"
    ],
    "example":{
        "include":"id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
        "exclude":"childSKUs.unitOfMeasure",
        "key":"productData"
    }
}

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

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createFilter_response

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 key passed in the request, which is the filterKey for the filter object created.

{
    "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 key passed in the request, which is the filterKey for the filter object created.",
            "type":"string"
        }
    }
}

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

• 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