Jump to

• Request
• Response

getRecommendationGlobalRuleConditions

get

/ccadmin/v1/recommendationGlobalRuleConditions

Get the list of Conditions available to build Recommendation Global Rules. This endpoint doesn't support paging, sorting or filtering.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following model is returned when operation succeeds.

Body ()

Root Schema : getRecommendationGlobalRuleConditions_response

Type: object

Show Source

• items(optional): array items
  The returned list of items.

{
    "properties":{
        "items":{
            "description":"The returned list of items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The localized display name of the Condition.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The ID of the Condition",
                        "type":"string"
                    },
                    "tag":{
                        "description":"The Condition's tag, used to group similar Conditions.",
                        "type":"string"
                    },
                    "params":{
                        "description":"The array of parameters for the Condition.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "options":{
                                    "description":"The optional array of options."
                                },
                                "id":{
                                    "description":" The parameter's ID.",
                                    "type":"string"
                                },
                                "type":{
                                    "description":"The data type of the parameter.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "operator":{
                        "description":"The localized display name for the Condition's operator.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The returned list of items.

Show Source

• Array of: object items

{
    "description":"The returned list of items.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The localized display name of the Condition.",
                "type":"string"
            },
            "id":{
                "description":"The ID of the Condition",
                "type":"string"
            },
            "tag":{
                "description":"The Condition's tag, used to group similar Conditions.",
                "type":"string"
            },
            "params":{
                "description":"The array of parameters for the Condition.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "options":{
                            "description":"The optional array of options."
                        },
                        "id":{
                            "description":" The parameter's ID.",
                            "type":"string"
                        },
                        "type":{
                            "description":"The data type of the parameter.",
                            "type":"string"
                        }
                    }
                }
            },
            "operator":{
                "description":"The localized display name for the Condition's operator.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The ID of the Condition
• label(optional): string
  The localized display name of the Condition.
• operator(optional): string
  The localized display name for the Condition's operator.
• params(optional): array params
  The array of parameters for the Condition.
• tag(optional): string
  The Condition's tag, used to group similar Conditions.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The localized display name of the Condition.",
            "type":"string"
        },
        "id":{
            "description":"The ID of the Condition",
            "type":"string"
        },
        "tag":{
            "description":"The Condition's tag, used to group similar Conditions.",
            "type":"string"
        },
        "params":{
            "description":"The array of parameters for the Condition.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "options":{
                        "description":"The optional array of options."
                    },
                    "id":{
                        "description":" The parameter's ID.",
                        "type":"string"
                    },
                    "type":{
                        "description":"The data type of the parameter.",
                        "type":"string"
                    }
                }
            }
        },
        "operator":{
            "description":"The localized display name for the Condition's operator.",
            "type":"string"
        }
    }
}

Nested Schema : params

Type: array

The array of parameters for the Condition.

Show Source

• Array of: object items

{
    "description":"The array of parameters for the Condition.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "options":{
                "description":"The optional array of options."
            },
            "id":{
                "description":" The parameter's ID.",
                "type":"string"
            },
            "type":{
                "description":"The data type of the parameter.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The parameter's ID.
• options(optional):
  The optional array of options.
• type(optional): string
  The data type of the parameter.

{
    "type":"object",
    "properties":{
        "options":{
            "description":"The optional array of options."
        },
        "id":{
            "description":" The parameter's ID.",
            "type":"string"
        },
        "type":{
            "description":"The data type of the parameter.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "totalResults":7,
    "items":[
        {
            "id":"inCurrentBrand",
            "label":"Brand",
            "tag":"brand",
            "operator":"is same as context"
        },
        {
            "id":"inSpecifiedBrand",
            "label":"Brand",
            "tag":"brand",
            "params":[
                {
                    "id":"brand",
                    "type":"string"
                }
            ],
            "operator":"is"
        },
        {
            "id":"inCurrentCollection",
            "label":"Collection",
            "tag":"collection",
            "operator":"is same as context"
        },
        {
            "id":"inSpecifiedCollection",
            "label":"Collection",
            "tag":"collection",
            "params":[
                {
                    "options":{
                        "endpointId":"listCollections",
                        "rel":"self",
                        "href":"/ccadminui/v1/collections"
                    },
                    "id":"collection",
                    "type":"collectionId"
                }
            ],
            "operator":"is"
        },
        {
            "id":"inCurrentPriceType",
            "label":"Price Type",
            "tag":"priceType",
            "operator":"is same as context"
        },
        {
            "id":"inSpecifiedPriceType",
            "label":"Price Type",
            "tag":"priceType",
            "params":[
                {
                    "options":[
                        {
                            "label":"Full Price",
                            "id":"fullPrice"
                        },
                        {
                            "label":"On Sale",
                            "id":"onSale"
                        }
                    ],
                    "id":"priceType",
                    "type":"priceTypeId"
                }
            ],
            "operator":"is"
        },
        {
            "id":"priceRange",
            "label":"Price",
            "params":[
                {
                    "id":"lowValue",
                    "type":"decimal"
                },
                {
                    "id":"highValue",
                    "type":"decimal"
                },
                {
                    "id":"currency",
                    "type":"string"
                }
            ],
            "operator":"between"
        }
    ]
}

Default Response

The error response.

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