catalogInfo/siblings

Last updated
Save as PDF

Important: Only call parameters that you need. Personalization Cloud operates off a set of APIs that support many applications and clients concurrently. Personalization Cloud may update and enhance these APIs at any time. If you are building a mobile app, please use our mobile SDKs.

http://recs.richrelevance.com/rrserver/api/rrPlatform/catalogInfo/siblings

Note: The URL requires the API key and parameter(s) to function properly. See below for more information on example URL requests.

Description: returns the siblings of a given category.

Parameters

Note: All parameters are case sensitive.

Name	Required or Optional	Description
apiKey	Required	A unique key that identifies the site. Each RichRelevance client has a unique API key to separate data and traffic from other clients. This is provided by RichRelevance. Example: apiKey=4faeaf752ee40a0f
apiClientKey	Required	A unique key specific to each API implementation. It identifies the specific application or client for reporting, permissions, and merchandising. This is provided by RichRelevance. Example: apiClientKey=b0126f995ac848159d
categoryId	Required	The category ID of the category the merchant wants to investigate. The value must match the external ID provided by the merchant to RichRelevance for the category. Example: categoryId=902312

Example Request

http://recs.richrelevance.com/rrserver/api/rrPlatform/catalogInfo/siblings?&apiClientKey=e9c9e05289be70e6&apiKey=showcaseparent&categoryId=Baby.Feeding

Example Response

{
    "name": "Feeding",
    "id": "Baby.Feeding",
    "siblingCategories": [{
        "hasChildren": true,
        "name": "Health & Safety",
        "id": "Baby.Health & Safety"
    }, {
        "hasChildren": true,
        "name": "Baby Days",
        "id": "Baby.Baby Days"
    }, {
        "hasChildren": true,
        "name": "Diapering & Potty",
        "id": "Baby.Diapering & Potty"
    }, {
        "hasChildren": true,
        "name": "Diapering",
        "id": "Baby.Diapering"
    }, {
        "hasChildren": true,
        "name": "Baby Specials",
        "id": "Baby.Baby Specials"
    }, {
        "hasChildren": false,
        "name": "Gifts for Baby",
        "id": "Baby.Gifts for Baby"
    }]
}

Response Definition

The response will be a JSON object containing the following fields:

Field	Description
id	The category ID
name	The name of the category
hasChildren	Does the category have subcategories? Valid values are true or false
siblingCategories	The siblings of this category; an array of categoryInfo objects