Skip to main content

Get related products (bulk)

GET 
/search/relations/bulk-results

Returns related products for multiple products based on identifiers. The response groups results per requested identifier.

⚠️ At least one of includeRelations or includeTags must be provided. Omitting both returns a 400 Bad Request error. You may send both.

Recommended limits

  • identifiers: up to 100, hard limit 1 000. Requests with more than 1 000 identifiers are rejected with 400 Bad Request.
  • includeRelations: up to 30 per request
  • includeTags: up to 30 per request

Larger requests may exceed URL length limits and fail. Split into multiple requests if needed.

includeRelations: define which relations to resolve by sending a list of relation ids paired with a limit.

Example: [{"id":6548, "limit":5}, {"id":9878, "limit":5}]

Relation ids can be copied from the three-dot menu next to each relation in the Data Platform. The limit determines how many related products are returned per requested relation.

includeTags: define which relations to resolve by sending a list of tag objects paired with a limitPerRelation.

Example: [{"tag":"Compatible", "limitPerRelation":4}]

Tags correspond with the relation type found in the Data Platform. limitPerRelation specifies how many products can be returned for each relation with a matching tag.

Please refer to this guide for details and examples.

Request​

Responses​

OK

{
    "424357": {
        "tags": [
            {
                "tag": "Compatible",
                "relations": [
                    {
                        "name": "Matching Accessories",
                        "id": 4728,
                        "localization": {
                            "names": []
                        },
                        "searchResult": [
                            [
                                {
                                    "identifier": "PRD-9876-BLU40",
                                    "groupId": "9876",
                                    "sxId": 240538699,
                                    "dataPoints": [
                                        {
                                            "id": 281559600,
                                            "conceptIdName": "CATEGORY",
                                            "key": "Category",
                                            "type": "PASS_ON",
                                            "value": "Cases",
                                            "isCategory": true
                                        }
                                    ],
                                    "image": "www.myshop.com/product/9876-blu40/img.jpg",
                                    "name": "Laptop Case 9876 Blue",
                                    "images": [
                                        {
                                            "type": "ALTERNATIVE",
                                            "url": "www.myshop.com/product/9876-blu40/img.jpg"
                                        }
                                    ],
                                    "link": "www.myshop.com/product/9876-blu40",
                                    "head": false,
                                    "relevance": 1000000
                                }
                            ]
                        ]
                    }
                ]
            }
        ]
    },
    "484365": {
        "tags": [
            {
                "tag": "Compatible",
                "relations": [
                    {
                        "name": "Matching Accessories",
                        "id": 4728,
                        "localization": {
                            "names": []
                        },
                        "searchResult": [
                            [
                                {
                                    "identifier": "PRD-5432-SLV20",
                                    "groupId": "5432",
                                    "sxId": 240538701,
                                    "dataPoints": [
                                        {
                                            "id": 281559600,
                                            "conceptIdName": "CATEGORY",
                                            "key": "Category",
                                            "type": "PASS_ON",
                                            "value": "Cases",
                                            "isCategory": true
                                        }
                                    ],
                                    "image": "www.myshop.com/product/5432-slv20/img.jpg",
                                    "name": "Laptop Case 5432 Silver",
                                    "images": [
                                        {
                                            "type": "ALTERNATIVE",
                                            "url": "www.myshop.com/product/5432-slv20/img.jpg"
                                        }
                                    ],
                                    "link": "www.myshop.com/product/5432-slv20",
                                    "head": false,
                                    "relevance": 999999
                                }
                            ]
                        ]
                    }
                ]
            }
        ]
    }
}