Jump to

• Request
• Response

getRecommendationStrategy

get

/ccstore/v1/recommendationStrategies/{id}

Get RecommendationStrategy. This operation is used to get a Recommendation Strategy from Oracle Commerce Cloud.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The RecommendationStrategy id.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following model is returned when operation succeeds.

Body ()

Root Schema : getRecommendationStrategy_response

Type: object

Show Source

• description(optional): string
  The description for the RecommendationStrategy.
• displayName(optional): string
  The display name for the RecommendationStrategy.
• id(optional): string
  The id of the RecommendationStrategy.
• recommendationGroups(optional): array recommendationGroups
  The recommendationGroups for the RecommendationStrategy.

{
    "properties":{
        "recommendationGroups":{
            "description":"The recommendationGroups for the RecommendationStrategy.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "numRecs":{
                        "description":"The number of recs to be returned by this recommendation group.",
                        "type":"integer"
                    },
                    "conditions":{
                        "description":"The conditions for the RecommendationGlobalRule.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "priceType":{
                                    "description":"The price type.  This is only valid when the condition requires a price type to be specified.  For example, a priceType is required for a condition with id notSpecifiedPriceType.",
                                    "type":"string"
                                },
                                "range":{
                                    "minItems":2,
                                    "maxItems":2,
                                    "description":"The price range used for evaluating the condition.  This is only valid when the condition requires a range to be specified.  For example, a range is required for a condition with id priceNotBetween.",
                                    "type":"array",
                                    "items":{
                                        "description":"Two numbers >= 0 with the first being lower than the second.  This represents a price range.",
                                        "type":"number"
                                    }
                                },
                                "currency":{
                                    "description":"The currency used for evaluating the condition.  This is only valid when the condition requires a currency to be specified.  For example, a currency is required for a condition with id priceGT.",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"The id of the condition.  This identifies the type of condition.  Some examples of condition ids are: notCurrentBrand, notSpecifiedCollection, priceNotBetween.",
                                    "type":"integer"
                                },
                                "collection":{
                                    "description":"The product collection.  This is only valid when the condition requires a collection to be specified.  For example, a collection is required for a condition with id notSpecifiedCollection.",
                                    "type":"string"
                                },
                                "locale":{
                                    "description":"The locale used for evaluating the condition.  This is only valid when the condition requires a locale to be specified.  For example, a locale is required for a condition with id notSpecifiedBrand.",
                                    "type":"string"
                                },
                                "brand":{
                                    "description":"The product brand.  This is only valid when the condition requires a brand to be specified.  For example, brand is required for the condition with id notSpecifiedBrand.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "displayName":{
            "description":"The display name for the RecommendationStrategy.",
            "type":"string"
        },
        "description":{
            "description":"The description for the RecommendationStrategy.",
            "type":"string"
        },
        "id":{
            "description":"The id of the RecommendationStrategy.",
            "type":"string"
        }
    },
    "example":{
        "recommendationGroups":[
            {
                "numRecs":1,
                "conditions":[
                    {
                        "id":"specifiedCollection",
                        "collection":"Shirts"
                    },
                    {
                        "range":[
                            50,
                            100
                        ],
                        "currency":"USD",
                        "id":"priceBetween"
                    }
                ]
            },
            {
                "numRecs":2,
                "conditions":[
                    {
                        "id":"specifiedCollection",
                        "collection":"Pants"
                    }
                ]
            }
        ],
        "displayName":"One Mid-Range Shirt and Two Pants",
        "description":"This is a description of oneMidRangeShirtAndTwoPants",
        "id":"oneMidRangeShirtAndTwoPants"
    }
}

Example:

{
    "recommendationGroups":[
        {
            "numRecs":1,
            "conditions":[
                {
                    "id":"specifiedCollection",
                    "collection":"Shirts"
                },
                {
                    "range":[
                        50,
                        100
                    ],
                    "currency":"USD",
                    "id":"priceBetween"
                }
            ]
        },
        {
            "numRecs":2,
            "conditions":[
                {
                    "id":"specifiedCollection",
                    "collection":"Pants"
                }
            ]
        }
    ],
    "displayName":"One Mid-Range Shirt and Two Pants",
    "description":"This is a description of oneMidRangeShirtAndTwoPants",
    "id":"oneMidRangeShirtAndTwoPants"
}

Nested Schema : recommendationGroups

Type: array

The recommendationGroups for the RecommendationStrategy.

Show Source

• Array of: object items

{
    "description":"The recommendationGroups for the RecommendationStrategy.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "numRecs":{
                "description":"The number of recs to be returned by this recommendation group.",
                "type":"integer"
            },
            "conditions":{
                "description":"The conditions for the RecommendationGlobalRule.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "priceType":{
                            "description":"The price type.  This is only valid when the condition requires a price type to be specified.  For example, a priceType is required for a condition with id notSpecifiedPriceType.",
                            "type":"string"
                        },
                        "range":{
                            "minItems":2,
                            "maxItems":2,
                            "description":"The price range used for evaluating the condition.  This is only valid when the condition requires a range to be specified.  For example, a range is required for a condition with id priceNotBetween.",
                            "type":"array",
                            "items":{
                                "description":"Two numbers >= 0 with the first being lower than the second.  This represents a price range.",
                                "type":"number"
                            }
                        },
                        "currency":{
                            "description":"The currency used for evaluating the condition.  This is only valid when the condition requires a currency to be specified.  For example, a currency is required for a condition with id priceGT.",
                            "type":"string"
                        },
                        "id":{
                            "description":"The id of the condition.  This identifies the type of condition.  Some examples of condition ids are: notCurrentBrand, notSpecifiedCollection, priceNotBetween.",
                            "type":"integer"
                        },
                        "collection":{
                            "description":"The product collection.  This is only valid when the condition requires a collection to be specified.  For example, a collection is required for a condition with id notSpecifiedCollection.",
                            "type":"string"
                        },
                        "locale":{
                            "description":"The locale used for evaluating the condition.  This is only valid when the condition requires a locale to be specified.  For example, a locale is required for a condition with id notSpecifiedBrand.",
                            "type":"string"
                        },
                        "brand":{
                            "description":"The product brand.  This is only valid when the condition requires a brand to be specified.  For example, brand is required for the condition with id notSpecifiedBrand.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• conditions(optional): array conditions
  The conditions for the RecommendationGlobalRule.
• numRecs(optional): integer
  The number of recs to be returned by this recommendation group.

{
    "type":"object",
    "properties":{
        "numRecs":{
            "description":"The number of recs to be returned by this recommendation group.",
            "type":"integer"
        },
        "conditions":{
            "description":"The conditions for the RecommendationGlobalRule.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "priceType":{
                        "description":"The price type.  This is only valid when the condition requires a price type to be specified.  For example, a priceType is required for a condition with id notSpecifiedPriceType.",
                        "type":"string"
                    },
                    "range":{
                        "minItems":2,
                        "maxItems":2,
                        "description":"The price range used for evaluating the condition.  This is only valid when the condition requires a range to be specified.  For example, a range is required for a condition with id priceNotBetween.",
                        "type":"array",
                        "items":{
                            "description":"Two numbers >= 0 with the first being lower than the second.  This represents a price range.",
                            "type":"number"
                        }
                    },
                    "currency":{
                        "description":"The currency used for evaluating the condition.  This is only valid when the condition requires a currency to be specified.  For example, a currency is required for a condition with id priceGT.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The id of the condition.  This identifies the type of condition.  Some examples of condition ids are: notCurrentBrand, notSpecifiedCollection, priceNotBetween.",
                        "type":"integer"
                    },
                    "collection":{
                        "description":"The product collection.  This is only valid when the condition requires a collection to be specified.  For example, a collection is required for a condition with id notSpecifiedCollection.",
                        "type":"string"
                    },
                    "locale":{
                        "description":"The locale used for evaluating the condition.  This is only valid when the condition requires a locale to be specified.  For example, a locale is required for a condition with id notSpecifiedBrand.",
                        "type":"string"
                    },
                    "brand":{
                        "description":"The product brand.  This is only valid when the condition requires a brand to be specified.  For example, brand is required for the condition with id notSpecifiedBrand.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : conditions

Type: array

The conditions for the RecommendationGlobalRule.

Show Source

• Array of: object items

{
    "description":"The conditions for the RecommendationGlobalRule.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "priceType":{
                "description":"The price type.  This is only valid when the condition requires a price type to be specified.  For example, a priceType is required for a condition with id notSpecifiedPriceType.",
                "type":"string"
            },
            "range":{
                "minItems":2,
                "maxItems":2,
                "description":"The price range used for evaluating the condition.  This is only valid when the condition requires a range to be specified.  For example, a range is required for a condition with id priceNotBetween.",
                "type":"array",
                "items":{
                    "description":"Two numbers >= 0 with the first being lower than the second.  This represents a price range.",
                    "type":"number"
                }
            },
            "currency":{
                "description":"The currency used for evaluating the condition.  This is only valid when the condition requires a currency to be specified.  For example, a currency is required for a condition with id priceGT.",
                "type":"string"
            },
            "id":{
                "description":"The id of the condition.  This identifies the type of condition.  Some examples of condition ids are: notCurrentBrand, notSpecifiedCollection, priceNotBetween.",
                "type":"integer"
            },
            "collection":{
                "description":"The product collection.  This is only valid when the condition requires a collection to be specified.  For example, a collection is required for a condition with id notSpecifiedCollection.",
                "type":"string"
            },
            "locale":{
                "description":"The locale used for evaluating the condition.  This is only valid when the condition requires a locale to be specified.  For example, a locale is required for a condition with id notSpecifiedBrand.",
                "type":"string"
            },
            "brand":{
                "description":"The product brand.  This is only valid when the condition requires a brand to be specified.  For example, brand is required for the condition with id notSpecifiedBrand.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• brand(optional): string
  The product brand. This is only valid when the condition requires a brand to be specified. For example, brand is required for the condition with id notSpecifiedBrand.
• collection(optional): string
  The product collection. This is only valid when the condition requires a collection to be specified. For example, a collection is required for a condition with id notSpecifiedCollection.
• currency(optional): string
  The currency used for evaluating the condition. This is only valid when the condition requires a currency to be specified. For example, a currency is required for a condition with id priceGT.
• id(optional): integer
  The id of the condition. This identifies the type of condition. Some examples of condition ids are: notCurrentBrand, notSpecifiedCollection, priceNotBetween.
• locale(optional): string
  The locale used for evaluating the condition. This is only valid when the condition requires a locale to be specified. For example, a locale is required for a condition with id notSpecifiedBrand.
• priceType(optional): string
  The price type. This is only valid when the condition requires a price type to be specified. For example, a priceType is required for a condition with id notSpecifiedPriceType.
• range(optional): array range
  Minimum Number of Items: 2

  Maximum Number of Items: 2

  The price range used for evaluating the condition. This is only valid when the condition requires a range to be specified. For example, a range is required for a condition with id priceNotBetween.

{
    "type":"object",
    "properties":{
        "priceType":{
            "description":"The price type.  This is only valid when the condition requires a price type to be specified.  For example, a priceType is required for a condition with id notSpecifiedPriceType.",
            "type":"string"
        },
        "range":{
            "minItems":2,
            "maxItems":2,
            "description":"The price range used for evaluating the condition.  This is only valid when the condition requires a range to be specified.  For example, a range is required for a condition with id priceNotBetween.",
            "type":"array",
            "items":{
                "description":"Two numbers >= 0 with the first being lower than the second.  This represents a price range.",
                "type":"number"
            }
        },
        "currency":{
            "description":"The currency used for evaluating the condition.  This is only valid when the condition requires a currency to be specified.  For example, a currency is required for a condition with id priceGT.",
            "type":"string"
        },
        "id":{
            "description":"The id of the condition.  This identifies the type of condition.  Some examples of condition ids are: notCurrentBrand, notSpecifiedCollection, priceNotBetween.",
            "type":"integer"
        },
        "collection":{
            "description":"The product collection.  This is only valid when the condition requires a collection to be specified.  For example, a collection is required for a condition with id notSpecifiedCollection.",
            "type":"string"
        },
        "locale":{
            "description":"The locale used for evaluating the condition.  This is only valid when the condition requires a locale to be specified.  For example, a locale is required for a condition with id notSpecifiedBrand.",
            "type":"string"
        },
        "brand":{
            "description":"The product brand.  This is only valid when the condition requires a brand to be specified.  For example, brand is required for the condition with id notSpecifiedBrand.",
            "type":"string"
        }
    }
}

Nested Schema : range

Type: array

Minimum Number of Items: 2

Maximum Number of Items: 2

The price range used for evaluating the condition. This is only valid when the condition requires a range to be specified. For example, a range is required for a condition with id priceNotBetween.

Show Source

• Array of: number
  Two numbers >= 0 with the first being lower than the second. This represents a price range.

{
    "minItems":2,
    "maxItems":2,
    "description":"The price range used for evaluating the condition.  This is only valid when the condition requires a range to be specified.  For example, a range is required for a condition with id priceNotBetween.",
    "type":"array",
    "items":{
        "description":"Two numbers >= 0 with the first being lower than the second.  This represents a price range.",
        "type":"number"
    }
}

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| |------------------|------------------| |52008|There is no Strategy with ID {0}.| |52006|A non-empty Strategy ID is required.| |52007|An error occurred accessing strategies.|

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"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"52006",
    "message":"A non-empty Strategy ID is required.",
    "status":"404"
}

Back to Top