1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Admin
  4. Recommendations

listRecommendationStrategies

get

/ccadmin/v1/recommendationStrategies

This operation is used to get the collection of Recommendation Strategies from Oracle Commerce Cloud.

Request

Supported Media Types
Query Parameters
  • This controls which fields are returned in the response body. The default is to include all Strategy fields.
  • This is the field to specify the number of records to be fetched per REST call.
  • This field specifies the offset/starting index from which data to be fetched.
  • This field specifies the query used to filter Strategies.
  • This field specifies the sort order of the list to be fetched.
  • Indicates if the total results should be included in the response.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listRecommendationStrategies_response
Type: object
Show Source
Nested Schema : items
Type: array
The returned list of items.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : recommendationGroups
Type: array
The array of Recommendation Groups for the Strategy.
Show Source
Nested Schema : items
Type: object
Show Source
  • conditions
    The array of Conditions and their parameters, if any. Conditions are described in the /recommendationStrategyConditions endpoint.
  • The number of recommendations to display from this set of Conditions.
Nested Schema : conditions
Type: array
The array of Conditions and their parameters, if any. Conditions are described in the /recommendationStrategyConditions endpoint.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "totalResults":4,
    "endingIndex":250,
    "offset":0,
    "totalResultsParam":true,
    "count":4,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/recommendationStrategies"
        }
    ],
    "sort":{
        "collator":null,
        "localeSensitiveSorting":false,
        "numDirectives":1,
        "empty":false
    },
    "items":[
        {
            "recommendationGroups":[
                {
                    "numRecs":5,
                    "conditions":[
                        {
                            "id":"browsedTogether"
                        }
                    ]
                }
            ],
            "displayName":"browsedTogether",
            "description":"This is a description of browsedTogether",
            "id":"browsedTogether"
        },
        {
            "recommendationGroups":[
                {
                    "numRecs":5,
                    "conditions":[
                        {
                            "id":"mostRecentlyViewed"
                        }
                    ]
                }
            ],
            "displayName":"mostRecentlyViewed",
            "description":"This is a description of mostRecentlyViewed",
            "id":"mostRecentlyViewed"
        },
        {
            "recommendationGroups":[
                {
                    "numRecs":5,
                    "conditions":[
                        {
                            "id":"purchasedTogether"
                        }
                    ]
                }
            ],
            "displayName":"purchasedTogether",
            "description":"This is a description of purchasedTogether",
            "id":"purchasedTogether"
        },
        {
            "recommendationGroups":[
                {
                    "numRecs":5,
                    "conditions":[
                        {
                            "id":"topSellers"
                        }
                    ]
                }
            ],
            "displayName":"topSellers",
            "description":"This is a description of topSellers",
            "id":"topSellers"
        }
    ],
    "collectionPaged":true,
    "listingRequest":null,
    "startingIndex":0,
    "totalNumberOfItems":4
}

Default Response

The error response.
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