Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The objects the API exposes, how they relate, and how an item moves through custody
| Object | Belongs to | Description |
|---|---|---|
| Organization | — | Your account. Everything below is scoped to it. |
| FBO account | Organization | An account holder. Inventory is owned here. Each organization has one primary FBO account (isPrimary: true), created with the organization, which is the default inventory holder. |
| Product | — | Catalog entry. Every inventory item is an instance of a product. |
| Inbound shipment | FBO account | Items being sent to the vault. Creates inventory items when accepted. |
| Inventory item | FBO account | One physical item in the vault. |
| Transfer | Organization | Moves inventory items from one FBO account to another. |
| Outbound request | FBO account | A request to ship inventory items out. |
| Outbound shipment | FBO account | The carrier shipment created once a request is picked. |
| Return shipment | FBO account | Items coming back after an outbound shipment. Handled like an inbound shipment. |
| Stage | Object | Status field | Webhook |
|---|---|---|---|
| Inbound | Inbound shipment | status | inbound_shipment.status_changed |
| Vaulted | Inventory item | status = in_vault | inventory.vaulted |
| Transfer | Transfer, then inventory item | status; item may be pending_transfer. Ownership moves at transfer.completed. | transfer.status_changed, transfer.completed |
| Outbound request | Outbound request | status; item keeps in_vault with openOutboundRequestId set | outbound_request.status_changed |
| Outbound shipment | Outbound shipment, then inventory item | status; item moves pending_outbound → shipped_out | outbound_shipment.status_changed, inventory.status_changed |
| Return | Inventory item | back to in_vault | inventory.status_changed |
