list_guest_documents · List my documents as a guest

Contract

shape: collection
authority: read
evidence: none
subscription: false
permission: any one of: org.guest (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_guest_documents
REST: POST https://api.containertradehq.com/v1/cap/list_guest_documents

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 the caller is a guest of.

Paginated: next next_after · ceiling not_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": {
          "document_kind": {
            "type": "string",
            "enum": [
              "asset_intake",
              "order"
            ],
            "description": "order (a lease) or asset_intake (a purchase order).",
            "x-data-class": "operational"
          },
          "document_id": {
            "type": "string",
            "description": "The document's id.",
            "x-data-class": "operational"
          },
          "seat": {
            "type": "string",
            "enum": [
              "lessee",
              "seller"
            ],
            "description": "The guest's seat on it.",
            "x-data-class": "operational"
          },
          "shape": {
            "type": "string",
            "enum": [
              "forwarder",
              "supplier"
            ],
            "description": "The guest's view: forwarder or supplier.",
            "x-data-class": "operational"
          },
          "reference": {
            "type": "string",
            "description": "What the document is called: an order's invoice number, a purchase order's PO number or booking number, else its id.",
            "x-data-class": "operational"
          },
          "document_type": {
            "type": [
              "string",
              "null"
            ],
            "description": "The order's sales order type or the purchase order's type.",
            "x-data-class": "operational"
          },
          "status": {
            "type": "string",
            "description": "The document's status.",
            "x-data-class": "operational"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "When it was made.",
            "x-data-class": "operational"
          },
          "offer": {
            "type": "boolean",
            "description": "An offer still waiting on the guest: a purchase order still pending.",
            "x-data-class": "operational"
          }
        },
        "required": [
          "document_kind",
          "document_id",
          "seat",
          "shape",
          "reference",
          "document_type",
          "status",
          "created_at",
          "offer"
        ],
        "additionalProperties": false
      }
    },
    "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

not yet declared

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 guest's listing
Outbound: the guest reads their own documents here; nothing is sent to them

Events

None emitted.

None.