getRecommendationStrategyConditions
get
/ccadmin/v1/recommendationStrategyConditions
Get the list of Conditions available to build Recommendation Strategies. This endpoint doesn't support paging, sorting or filtering.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The following model is returned when operation succeeds.
Root Schema : getRecommendationStrategyConditions_response
Type:
Show Source
object-
items(optional):
array items
The returned list of items.
Nested Schema : items
Type:
Show Source
object-
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.
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
The parameter's ID.
-
options(optional):
The optional array of options.
-
type(optional):
string
The data type of the parameter.
Example Response (application/json)
{
"totalResults":12,
"items":[
{
"id":"topSellers",
"label":"Top Sellers"
},
{
"id":"purchasedTogether",
"label":"Purchased Together"
},
{
"id":"browsedTogether",
"label":"Browsed Together"
},
{
"id":"mostRecentlyViewed",
"label":"Most Recently Viewed"
},
{
"id":"manuallyRelatedProducts",
"label":"Manually Related Products"
},
{
"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.
Root Schema : errorModel
Type:
Show Source
object-
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
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
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