Contract
- shape
- collection
- authority
- read
- evidence
- none
- subscription
- false
- permission
- any one of: org.member (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_inventory
- REST
- POST https://api.containertradehq.com/v1/cap/list_inventory
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 inventory it is. |
| filters | filters | optional | Units matching every term given. With no acquisition term, units pending or acquired. |
| q | text | optional | 1 to 64 characters The start of a BIC number, booking number, release booking number, intake id, vendor bill id or invoice number. |
| sort | sort | optional | 1 to 1 items; default [{"key":"updated_at","dir":"desc"}] One sort key and its direction. Most recently changed first when left out. |
| fields | fields | optional | 1 to any number of items; unique; default ["bic","acquisition","availability","custody","repair_state","tags","internal_notes","created_at","updated_at","size","type","condition","color","color_ral","year_of_make","forklift_pockets","handles","lockbox","vents","depot","in_depot_since","gated_out_at","duration_days","release_booking_number"] The fields to answer, from the field groups. The unit, container and residency groups when left out. |
| limit | integer | optional | 1 to 500; default 100 The page size. |
| after | cursor | optional | tradehq-keyset-cursor; up to 1024 characters The previous page's next_after. |
Paginated: cursor_input after · next next_after · page_max 500 · walk_max 10000 · 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": {
"asset_id": {
"type": "string",
"description": "The unit's id.",
"x-data-class": "operational"
},
"bic": {
"type": [
"string",
"null"
],
"description": "The container's BIC number.",
"x-data-class": "operational"
},
"acquisition": {
"type": [
"string",
"null"
],
"enum": [
"pending",
"acquired",
"cancelled",
null
],
"description": "Its acquisition state.",
"x-data-class": "operational"
},
"availability": {
"type": [
"string",
"null"
],
"enum": [
"available",
"committed",
"withdrawn",
null
],
"description": "Its availability state; null once cancelled.",
"x-data-class": "operational"
},
"custody": {
"type": [
"string",
"null"
],
"enum": [
"in-depot",
"on-hire",
"disposed",
"in-transit",
null
],
"description": "Its custody state; null while pending and once cancelled.",
"x-data-class": "operational"
},
"repair_state": {
"type": "string",
"enum": [
"undamaged",
"awaiting-estimate",
"pending-approval",
"pending-repair",
"repaired",
"unrepairable",
"damaged-not-repaired"
],
"description": "Its repair state.",
"x-data-class": "operational"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The org's tags on it.",
"x-data-class": "operational"
},
"internal_notes": {
"type": [
"string",
"null"
],
"description": "The org's notes on it.",
"x-data-class": "operational"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When it was recorded.",
"x-data-class": "operational"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When it last changed.",
"x-data-class": "operational"
},
"size": {
"type": [
"string",
"null"
],
"description": "Its size as recorded.",
"x-data-class": "operational"
},
"type": {
"type": [
"string",
"null"
],
"description": "Its type as recorded.",
"x-data-class": "operational"
},
"condition": {
"type": [
"string",
"null"
],
"description": "Its condition grade as recorded.",
"x-data-class": "operational"
},
"color": {
"type": [
"string",
"null"
],
"description": "Its colour.",
"x-data-class": "operational"
},
"color_ral": {
"type": [
"integer",
"null"
],
"description": "Its RAL colour number.",
"x-data-class": "operational"
},
"year_of_make": {
"type": [
"integer",
"null"
],
"description": "The year it was built.",
"x-data-class": "operational"
},
"forklift_pockets": {
"type": [
"boolean",
"null"
],
"description": "Whether it has forklift pockets.",
"x-data-class": "operational"
},
"handles": {
"type": [
"string",
"null"
],
"description": "Its door handles.",
"x-data-class": "operational"
},
"lockbox": {
"type": [
"boolean",
"null"
],
"description": "Whether it has a lockbox.",
"x-data-class": "operational"
},
"vents": {
"type": [
"string",
"null"
],
"description": "Its vents.",
"x-data-class": "operational"
},
"intake_id": {
"type": [
"string",
"null"
],
"description": "Its most recent intake.",
"x-data-class": "operational"
},
"acquisition_channel": {
"type": [
"string",
"null"
],
"enum": [
"direct",
"gate-buy",
"yard-buy",
"consignment",
"factory-direct",
"inland-transfer",
"open-inventory",
null
],
"description": "How the holder sourced it.",
"x-data-class": "operational"
},
"pickup_date": {
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
"format": "date",
"description": "When its purchase order picks it up at the origin, the P/U Date.",
"x-data-class": "operational"
},
"vendor_eta": {
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
"format": "date",
"description": "When the vendor expects to deliver it.",
"x-data-class": "operational"
},
"transit_days": {
"type": [
"integer",
"null"
],
"description": "Days from its P/U Date to its vendor ETA; null when either is missing, negative when the ETA is first.",
"x-data-class": "operational"
},
"booking_number": {
"type": [
"string",
"null"
],
"description": "The intake's booking number.",
"x-data-class": "operational"
},
"intake_depot": {
"type": [
"string",
"null"
],
"description": "The depot the intake names.",
"x-data-class": "operational"
},
"origin_market": {
"type": [
"string",
"null"
],
"description": "The market its purchase order picks it up in, its origin.",
"x-data-class": "operational"
},
"origin_depot": {
"type": [
"string",
"null"
],
"description": "The depot its purchase order picks it up at, its origin depot.",
"x-data-class": "operational"
},
"nearest_metro": {
"type": [
"string",
"null"
],
"description": "The intake's nearest metro.",
"x-data-class": "operational"
},
"fee_responsibility": {
"type": [
"string",
"null"
],
"description": "Who pays the yard fees.",
"x-data-class": "operational"
},
"depot": {
"type": [
"string",
"null"
],
"description": "The depot of its most recent residency.",
"x-data-class": "operational"
},
"in_depot_since": {
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
"format": "date",
"description": "When that residency began.",
"x-data-class": "operational"
},
"gated_out_at": {
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
"format": "date",
"description": "When that residency ended.",
"x-data-class": "operational"
},
"duration_days": {
"type": [
"integer",
"null"
],
"description": "Days in that residency.",
"x-data-class": "operational"
},
"release_booking_number": {
"type": [
"string",
"null"
],
"description": "Its release's booking number.",
"x-data-class": "operational"
},
"holding_basis": {
"type": [
"string",
"null"
],
"enum": [
"owned",
"leased-in",
"subleased",
null
],
"description": "The basis on which the holder holds it.",
"x-data-class": "operational"
},
"vendor": {
"type": [
"string",
"null"
],
"description": "The vendor contact.",
"x-data-class": "operational"
},
"vendor_bill_id": {
"type": [
"string",
"null"
],
"description": "The vendor's bill.",
"x-data-class": "operational"
},
"vendor_bill_paid_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When the vendor's bill was paid.",
"x-data-class": "operational"
},
"purchase_price": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its purchase price, as a decimal string.",
"x-data-class": "commercial"
},
"lease_price": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its lease price, as a decimal string.",
"x-data-class": "commercial"
},
"lease_term": {
"type": [
"string",
"null"
],
"description": "Its lease term.",
"x-data-class": "operational"
},
"order_id": {
"type": [
"string",
"null"
],
"description": "Its most recent order.",
"x-data-class": "operational"
},
"customer": {
"type": [
"string",
"null"
],
"description": "That order's customer contact.",
"x-data-class": "operational"
},
"invoice_number": {
"type": [
"string",
"null"
],
"description": "That order's invoice number.",
"x-data-class": "operational"
},
"sales_order_type": {
"type": [
"string",
"null"
],
"description": "That order's type.",
"x-data-class": "operational"
},
"reserved_price": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its active reservation's price, as a decimal string.",
"x-data-class": "commercial"
},
"listed": {
"type": [
"boolean",
"null"
],
"description": "Whether it is listed for sale.",
"x-data-class": "operational"
},
"list_price": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its list price, as a decimal string.",
"x-data-class": "commercial"
},
"lease_base_price": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its lease base price, as a decimal string.",
"x-data-class": "commercial"
},
"lease_base_duration": {
"type": [
"integer",
"null"
],
"description": "Its lease base duration.",
"x-data-class": "operational"
},
"purchase_terms": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its purchase terms.",
"x-data-class": "financial"
},
"total_cost": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its total cost in USD, as a decimal string.",
"x-data-class": "commercial"
},
"available": {
"type": "boolean",
"description": "Whether it is available to sell.",
"x-data-class": "operational"
},
"repair_cost": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its repair costs in USD, as a decimal string.",
"x-data-class": "commercial"
},
"transport_cost": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its transport costs in USD, as a decimal string.",
"x-data-class": "commercial"
},
"other_cost": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its other costs in USD, as a decimal string.",
"x-data-class": "commercial"
},
"fee_currency": {
"type": [
"string",
"null"
],
"description": "The currency of its projected fees.",
"x-data-class": "operational"
},
"fee_gate_in": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its projected gate-in fee, as a decimal string.",
"x-data-class": "commercial"
},
"fee_gate_out": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its projected gate-out fee, as a decimal string.",
"x-data-class": "commercial"
},
"fee_lift": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its projected lift fees, as a decimal string.",
"x-data-class": "commercial"
},
"fee_storage": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its projected storage fees, as a decimal string.",
"x-data-class": "commercial"
},
"fee_total": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"const": "•••",
"description": "Masked by the caller's data policy."
},
{
"type": "null",
"description": "Denied by the caller's data policy."
}
],
"description": "Its projected fees in total, as a decimal string.",
"x-data-class": "commercial"
}
},
"required": [
"asset_id"
],
"additionalProperties": false
},
"maxItems": 500
},
"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
walk_ceiling_reached· 422 · the cursor walk has answered 10,000 rows, the most one walk answers
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 an inventory listing
- Outbound: a read emits nothing
Events
None emitted.
Related
list_catalog, list_shared_catalog, list_units, summarize_catalog, summarize_inventory