Skip to main content

SharedOrganization

idintegerrequired

Internal system ID of the shared organization

Example: 733
externalIdstringrequired

The customer-defined ID of the shared organization

Possible values: <= 255 characters

Example: Dung_local_retailer001
inspIdstringrequired

Human-readable Inspectorio-generated ID

Possible values: <= 10 characters

Example: U5NX1E2BD
namestringrequired

Name of the shared organization

Possible values: <= 255 characters

Example: Dung global retailer 001
typestringrequired

Classification of the organization.

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

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

Example: R
capabilitiesstring[]required

List of the shared organization's capabilities

Possible values: <= 255 characters

Example: ["Pulp making","Raw Material Processing or Production"]
externalStatusstring

Status of the organization from the API consumer's system

Possible values: <= 20 characters

Example: pending approval
countrystringrequired

ISO 3166-1 alpha-2 country code of the organization

Possible values: <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Example: US
permissionsstring[]required

List of permissions granted on the shared organization

Possible values: [read, write, full]

Example: ["read"]
createdAtdate-timerequired

Timestamp when the shared organization was created

Possible values: Value must match regular expression ^\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d(\.\d{3})?Z$

Example: 2025-04-14T10:32:41Z
updatedAtdate-timerequired

Timestamp when the shared organization was last updated

Possible values: Value must match regular expression ^\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d(\.\d{3})?Z$

Example: 2025-04-18T09:24:02Z
sharedBy objectrequired

The organization that shared this organization

idintegerrequired

Internal system ID

Example: 616
namestringrequired

Name of the sharing organization

Possible values: <= 255 characters

Example: Dung Test 1742206220061
externalIdstringrequired

The customer-defined ID of the sharing org

Possible values: <= 255 characters

Example: 011131742206220061
inspIdstringrequired

Custom human-readable Inspectorio-generated ID

Possible values: <= 10 characters

Example: 38TCUXYADY
SharedOrganization
{
  "id": 733,
  "externalId": "Dung_local_retailer001",
  "inspId": "U5NX1E2BD",
  "name": "Dung global retailer 001",
  "type": "R",
  "capabilities": [
    "Pulp making",
    "Raw Material Processing or Production"
  ],
  "externalStatus": "pending approval",
  "country": "US",
  "permissions": [
    "read"
  ],
  "createdAt": "2025-04-14T10:32:41Z",
  "updatedAt": "2025-04-18T09:24:02Z",
  "sharedBy": {
    "id": 616,
    "name": "Dung Test 1742206220061",
    "externalId": "011131742206220061",
    "inspId": "38TCUXYADY"
  }
}