Skip to main content

Get resolved relations

GET 
/search/v1/:project-id/relations/resolved-relations

Returns related products for a single product based on identifier.

You must use one of the "include" parameters, either include-relations or include-tags.

include-relations: 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.

include-tags: 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.

Request​

Responses​

OK

{
  "tags": [
    {
      "tag": "Compatible",
      "relations": [
        {
          "name": "Matching Accessories",
          "id": 4728,
          "searchResult": [
          {
            "identifier": "PRD-9876-BLU40",
            "groupId": "9876",
            "sxId": 240538699,
            "name": "Laptop Case 9876 Blue",
            "brand": "BrandX",
            "category": "Cases",
            "image": "www.myshop.com/product/9876-blu40/img.jpg",
            "link": "www.myshop.com/product/9876-blu40",
            "relevance": 1000000
          }
          ]
        }
      ]
    }
  ]
}