---
displayed_sidebar: productReference
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# JoinerRelationship

 **JoinerRelationship**: `Object`

## Type declaration

<ParameterTypes parameters={[
  {
    "name": "alias",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "args",
    "type": "`Record<string, any>`",
    "description": "Extra arguments to pass to the remoteFetchData callback",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "foreignKey",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "inverse",
    "type": "`boolean`",
    "description": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "isInternalService",
    "type": "`boolean`",
    "description": "If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "isList",
    "type": "`boolean`",
    "description": "Force the relationship to return a list",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "primaryKey",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "serviceName",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />
