SubOrganizationRelationship

Represents a relationship between a sub-organization and a target organization

target objectrequired

The organization linked to the sub-organization

idintegerrequired

Internal ID of the organization

Example: 5537

externalIdstring | nullnullablerequired

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

Possible values: <= 255 characters

Example: ID-LOCAL

typestringrequired

Type of the organization.

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

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

Example: B

namestringrequired

Display name of the organization

Possible values: <= 255 characters

Example: LOCAL_ORG_CHECK

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]

Example: draft

relationshipStatusstringrequired

Indicates the current status of the relationship

Possible values: [active, inactive]

Example: active

SubOrganizationRelationship

{
  "target": {
    "id": 5537,
    "externalId": "ID-LOCAL",
    "type": "B",
    "name": "LOCAL_ORG_CHECK",
    "inspId": null,
    "externalStatus": "draft"
  },
  "relationshipStatus": "active"
}