list_supplier_relationships · List supplier relationships

Contract

shape: collection
authority: read
evidence: none
subscription: false
permission: any one of: org.admin (carried by the caller's role template in the org `org_id`); a deactivated caller is refused first
idempotency: safe
emits: none
MCP tool: list_supplier_relationships
REST: POST https://api.containertradehq.com/v1/cap/list_supplier_relationships

Idempotency: a read: calling again changes nothing

Inputs

name	type	required	validation
org_id	org_id	required	tradehq-org-id; 1 to 20 characters The org whose supplying parties to list.

Paginated: next next_after · page_max 1000 · walk_max 1000 · ceiling declared

Response

items · object[]
next_after · stringnull · Pass as `after` for the next page; null on the last one.

Full JSON Schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "contact_id": {
            "type": "string",
            "description": "The party: the org's contact an intake names as its vendor.",
            "x-data-class": "operational"
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "description": "The contact's name.",
            "x-data-class": "operational"
          },
          "relationship": {
            "type": "string",
            "enum": [
              "partner",
              "supplier"
            ],
            "description": "How the org stands with it: the relationship recorded, else partner when it feeds the org by API, else supplier. The catalog shows its unowned inventory under this source.",
            "x-data-class": "operational"
          },
          "recorded": {
            "type": "boolean",
            "description": "Whether an org admin recorded the relationship; false when it is the default.",
            "x-data-class": "operational"
          },
          "api_fed": {
            "type": "boolean",
            "description": "Whether the party feeds the org's inventory by API, which makes it a partner unless a relationship is recorded.",
            "x-data-class": "operational"
          },
          "set_by": {
            "type": [
              "string",
              "null"
            ],
            "description": "The user_id of the org admin who recorded the relationship; null when none is recorded.",
            "x-data-class": "operational"
          },
          "set_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When it was recorded; null when none is.",
            "x-data-class": "operational"
          },
          "api_fed_by": {
            "type": [
              "string",
              "null"
            ],
            "description": "Who last recorded the API feed: a user_id, or declaration:<ticket>; null when the party has none.",
            "x-data-class": "operational"
          },
          "api_fed_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the API feed was last recorded; null when the party has none.",
            "x-data-class": "operational"
          }
        },
        "required": [
          "contact_id",
          "name",
          "relationship",
          "recorded",
          "api_fed",
          "set_by",
          "set_at",
          "api_fed_by",
          "api_fed_at"
        ],
        "additionalProperties": false
      },
      "maxItems": 1000
    },
    "next_after": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass as `after` for the next page; null on the last one."
    }
  },
  "required": [
    "items",
    "next_after"
  ],
  "additionalProperties": false
}

Refusals

The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.

Surfaces

DesktopF

MobileF

APIF

MCPF

VoiceD4

PushN

OneBoxN

OutboundN

Voice: degraded: visualization
Push: emits nothing
OneBox: no document originates a supplier relationship
Outbound: crosses to no counterparty

Events

None emitted.

None.