Skip to main content
1

Create the shipment

Create FBO account returns id and vaultId. Get the intake address with that id and ship the package to formatted.To create an inbound shipment, send a request to the inbound shipments endpoint. The required fields are fboAccountId from that account, lines, and either rateId or carrier and trackingNumber. Each line needs a product id from list products and quantityDeclared.
The response returns a status of created. Until the carrier scans the package, the shipment can be cancelled with the cancel endpoint.
2

On its way

Once the carrier has scanned the package, the status becomes in_transit. There are no more updates until the package reaches the vault and the inbound_shipment.status_changed webhook arrives with a toStatus of processing.
3

Processing at the vault

While the status is processing, the package is being checked. A package that arrives without a create starts at processing. Wait for the inbound_shipment.status_changed webhook with a toStatus of accepted or rejected. accepted closes the shipment. Pass includeLineItems=true on Get Inbound Shipment and read quantityAccepted, quantityRejected, and inventoryItemIds per line. A line can be accepted for fewer units than quantityDeclared. The vaulted items are then on list inventory. rejected means nothing was taken in.