REST API for Oracle Commerce Cloud December 2017

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 Parameter

Root Schema : createFilter_request

Example


{
    "include":"id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
    "exclude":"childSKUs.unitOfMeasure",
    "key":"productData"
}

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

Required: true

The filterKey for the filter to create.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createFilter_response

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

Example 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

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 Request:

{
  "include": "id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
  "exclude": "childSKUs.unitOfMeasure",
  "key": "productData"
}

Sample Response Payload returned by endpoint:

{
  "include": "id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
  "exclude": "childSKUs.unitOfMeasure",
  "key": "productData"
}