Jump to

• Request
• Response

listRecommendationGlobalRules

get

/ccstore/v1/recommendationGlobalRules

List Recommendation Global Rules. This operation is used to get the collection of Recommendation Global Rules. By default all properties on the Recommendation Global Rule items are returned.

Request

Supported Media Types

• application/json

Query Parameters

• fields(optional): string
  This controls which fields are returned in the response body.
• limit(optional): integer
  This is the field to specify the number of records to be fetched per REST call.
• offset(optional): integer
  This field specifies the offset/starting index from which data to be fetched.
• q(optional): string
  This field specifies the query used to limit Audiences.
• sort(optional): string
  This field specifies the sort order of the list to be fetched.
• totalResults(optional): boolean
  Indicates if the total results should be included in the response.

Header Parameters

• Accept-Language: string
  The locale.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following model is returned when operation succeeds.

Body ()

Root Schema : listRecommendationGlobalRule_response

Type: object

Show Source

• items(optional): array items
  The returned list of items.
• limit(optional): integer
  Maximum number of RecommendationGlobalRules to be fetched.
• offset(optional): integer
  The starting index of the returned RecommendationGlobalRules.
• sort(optional): array sort
  The sort used for the RecommendationGlobalRules audiences.
• totalResults(optional): integer
  The total number of RecommendationGlobalRules that match the supplied filter.

{
    "properties":{
        "totalResults":{
            "description":"The total number of RecommendationGlobalRules that match the supplied filter.",
            "type":"integer"
        },
        "offset":{
            "description":"The starting index of the returned RecommendationGlobalRules.",
            "type":"integer"
        },
        "limit":{
            "description":"Maximum number of RecommendationGlobalRules to be fetched.",
            "type":"integer"
        },
        "sort":{
            "description":"The sort used for the RecommendationGlobalRules audiences.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The property sorted on.",
                        "type":"string"
                    },
                    "order":{
                        "description":"The sort order: either asc or desc.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"The returned list of items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"The display name for the RecommendationGlobalRule.",
                        "type":"string"
                    },
                    "description":{
                        "description":"The description for the ReommendationGlobalRule.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The id of the RecommendationGlobalRule.",
                        "type":"string"
                    },
                    "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"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "example":{
        "totalResults":3,
        "offset":0,
        "sort":{
            "property":"displayName",
            "order":"asc"
        },
        "items":[
            {
                "displayName":"noProductsInCurrentBrand",
                "description":"This is a description of noProductsInCurrentBrand",
                "id":"noProductsInCurrentBrand",
                "conditions":[
                    {
                        "id":"notCurrentBrand"
                    }
                ]
            },
            {
                "displayName":"noProductsInCurrentCollection",
                "description":"This is a description of noProductsInCurrentCollection",
                "id":"noProductsInCurrentCollection",
                "conditions":[
                    {
                        "id":"notCurrentCollection"
                    }
                ]
            },
            {
                "displayName":"noProductsInCurrentPriceType",
                "description":"This is a description of noProductsInCurrentPriceType",
                "id":"noProductsInCurrentPriceType",
                "conditions":[
                    {
                        "id":"notCurrentPriceType"
                    }
                ]
            }
        ]
    }
}

Example:

{
    "totalResults":3,
    "offset":0,
    "sort":{
        "property":"displayName",
        "order":"asc"
    },
    "items":[
        {
            "displayName":"noProductsInCurrentBrand",
            "description":"This is a description of noProductsInCurrentBrand",
            "id":"noProductsInCurrentBrand",
            "conditions":[
                {
                    "id":"notCurrentBrand"
                }
            ]
        },
        {
            "displayName":"noProductsInCurrentCollection",
            "description":"This is a description of noProductsInCurrentCollection",
            "id":"noProductsInCurrentCollection",
            "conditions":[
                {
                    "id":"notCurrentCollection"
                }
            ]
        },
        {
            "displayName":"noProductsInCurrentPriceType",
            "description":"This is a description of noProductsInCurrentPriceType",
            "id":"noProductsInCurrentPriceType",
            "conditions":[
                {
                    "id":"notCurrentPriceType"
                }
            ]
        }
    ]
}

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":{
            "displayName":{
                "description":"The display name for the RecommendationGlobalRule.",
                "type":"string"
            },
            "description":{
                "description":"The description for the ReommendationGlobalRule.",
                "type":"string"
            },
            "id":{
                "description":"The id of the RecommendationGlobalRule.",
                "type":"string"
            },
            "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 : sort

Type: array

The sort used for the RecommendationGlobalRules audiences.

Show Source

• Array of: object items

{
    "description":"The sort used for the RecommendationGlobalRules audiences.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The property sorted on.",
                "type":"string"
            },
            "order":{
                "description":"The sort order: either asc or desc.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• conditions(optional): array conditions
  The conditions for the RecommendationGlobalRule.
• description(optional): string
  The description for the ReommendationGlobalRule.
• displayName(optional): string
  The display name for the RecommendationGlobalRule.
• id(optional): string
  The id of the RecommendationGlobalRule.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"The display name for the RecommendationGlobalRule.",
            "type":"string"
        },
        "description":{
            "description":"The description for the ReommendationGlobalRule.",
            "type":"string"
        },
        "id":{
            "description":"The id of the RecommendationGlobalRule.",
            "type":"string"
        },
        "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"
    }
}

Nested Schema : items

Type: object

Show Source

• order(optional): string
  The sort order: either asc or desc.
• property(optional): string
  The property sorted on.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The property sorted on.",
            "type":"string"
        },
        "order":{
            "description":"The sort order: either asc or desc.",
            "type":"string"
        }
    }
}

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| |------------------|------------------| |52044|Unable to access Global Rules due to missing request and query.| |52048|An error occurred accessing Global Rules with query {0}.|

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":"52044",
    "message":"Unable to access Global Rules due to missing request and query.",
    "status":"404"
}

Back to Top