Skip to main content

Relationship

Represents a relationship between organizations in the supply chain

target objectrequired

The organization at the other end of the relationship

idintegerrequired

Internal ID of the organization

Example: 1122
externalIdstring | nullnullablerequired

External ID of the organization, as provided by the API consumer

Possible values: <= 255 characters

Example: F1111
typestringrequired

Type of the organization.

  • F: Factory
  • S: Supplier
  • R: Retailer
  • B: Brand
  • I: Inspection Agency

Possible values: [F, S, B, R, I]

Example: F
namestringrequired

Display name of the organization

Possible values: <= 255 characters

Example: Local Factory 111
inspIdstring | nullnullablerequired

System identifier used in application URLs (nullable)

Possible values: <= 10 characters

Example: null
externalStatusstring | nullnullablerequired

Organization status as defined by the external system or API consumer (nullable)

Possible values: [active, inactive, awaiting approval, draft, suspended, blacklisted, closed, null]

Example: active
leadSupplier object

The designated lead supplier for this relationship, if defined

anyOf

Organization information in a relationship context

idintegerrequired

Internal ID of the organization

Example: 1122
externalIdstring | nullnullablerequired

External ID of the organization, as provided by the API consumer

Possible values: <= 255 characters

Example: F1111
typestringrequired

Type of the organization.

  • F: Factory
  • S: Supplier
  • R: Retailer
  • B: Brand
  • I: Inspection Agency

Possible values: [F, S, B, R, I]

Example: F
namestringrequired

Display name of the organization

Possible values: <= 255 characters

Example: Local Factory 111
inspIdstring | nullnullablerequired

System identifier used in application URLs (nullable)

Possible values: <= 10 characters

Example: null
externalStatusstring | nullnullablerequired

Organization status as defined by the external system or API consumer (nullable)

Possible values: [active, inactive, awaiting approval, draft, suspended, blacklisted, closed, null]

Example: active
typestringrequired

The relationship type between the organizations is defined by the customer. Refer to the List Relationship Types endpoint to retrieve the full list of supported values.

Possible values: <= 255 characters

Example: contract manufacturer
relationshipStatusstringrequired

Indicates the current status of the relationship

Possible values: [active, inactive]

Example: active
authorizedCapabilitiesstring[]required

Capabilities the target organization is authorized to perform within this relationship. Refer to the List Capabilities endpoint to retrieve the full list of supported values.

Possible values: <= 255 characters

Example: ["Boiling","Breeding"]
customFieldsobject

Key-value pairs for any custom data linked to the relationship

Example: {"custom1":"2025-01-01"}
permissionsstring[]required

List of permissions granted to the user for managing or viewing this relationship

Possible values: [read, edit, full, share, relationship-read, relationship-edit, request-onboard]

Example: ["edit","full","read"]
Relationship
{
  "target": {
    "id": 1122,
    "externalId": "F1111",
    "type": "F",
    "name": "Local Factory 111",
    "inspId": null,
    "externalStatus": "active"
  },
  "leadSupplier": {
    "id": 1122,
    "externalId": "F1111",
    "type": "F",
    "name": "Local Factory 111",
    "inspId": null,
    "externalStatus": "active"
  },
  "type": "contract manufacturer",
  "relationshipStatus": "active",
  "authorizedCapabilities": [
    "Boiling",
    "Breeding"
  ],
  "customFields": {
    "custom1": "2025-01-01"
  },
  "permissions": [
    "edit",
    "full",
    "read"
  ]
}