List the relationships of a listing

GET

/listings/{parent_listing_id}/related

const url = 'https://acme.mykreezalid.com/front_api/v1/listings/4242/related?type=up-sell';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://acme.mykreezalid.com/front_api/v1/listings/4242/related?type=up-sell'

Returns the relationships from a parent listing, sorted by sort_priority. Works without an access token; a token changes nothing. Only the relationships are returned, not the related listings themselves.

Parameters

Path Parameters

parent_listing_id

required

integer

ID of the parent listing.

Example

Query Parameters

type

string

Allowed values: up-sell cross-sell other

Only return relationships of this kind. Any other value is ignored.

Responses

200

The relationships.

application/json

object

relationships

Array<object>

A relationship from a parent listing to a related listing (for example a cross-sell suggestion).

object

integer

parent_listing_id

Listing the relationship starts from.

integer

listing_id

Related listing.

integer

createdBy

Member who created the relationship. Always null for relationships created through the Front API.

integer

nullable

type

Kind of relationship. up-sell, cross-sell and other are the values the list and delete operations recognise.

string

sort_priority

Position of the related listing; lists are sorted on it, lowest first.

integer

description

string

nullable

extra

Free-form extra data.

string

nullable

created

string format: date-time

modified

string format: date-time

Example

{
  "relationships": [
    {
      "id": 55,
      "parent_listing_id": 4242,
      "listing_id": 4243,
      "type": "cross-sell",
      "sort_priority": 0,
      "description": "Goes well with",
      "created": "2026-10-13T09:30:00+00:00",
      "modified": "2026-10-13T09:30:00+00:00"
    }
  ]
}

400

The parent listing ID is not a number.

application/json

Error body returned by the Front API when it refuses a request.

object

code

HTTP status code, repeated in the body.

integer

status

string

message

Human-readable reason.

string

Example

{
  "code": 403,
  "status": "error",
  "message": "Token not found in request"
}

404

No listing with this ID.

application/json

Error body returned by the Front API when it refuses a request.

object

code

HTTP status code, repeated in the body.

integer

status

string

message

Human-readable reason.

string

Example

{
  "code": 403,
  "status": "error",
  "message": "Token not found in request"
}