Skip to main content

RelationshipOrganization

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
RelationshipOrganization
{
"id": 1122,
"externalId": "F1111",
"type": "F",
"name": "Local Factory 111",
"inspId": null
}