{
"fboAccountId": "m97fbo456",
"notes": "Ship to primary address",
"destinationAddress": {
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"items": [{ "inventoryItemId": "jk7inv456" }]
}
{
"fboAccountId": "m97fbo456",
"destinationAddress": {
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"shipping": {
"mode": "selected",
"signatureType": "Signature",
"serviceCode": "FEDEX_GROUND"
},
"items": [{ "inventoryItemId": "jk7inv456" }]
}
Outbound Requests
Create Outbound Request
Create an outbound request with inventory items
POST
/
outbound-requests
{
"fboAccountId": "m97fbo456",
"notes": "Ship to primary address",
"destinationAddress": {
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"items": [{ "inventoryItemId": "jk7inv456" }]
}
{
"fboAccountId": "m97fbo456",
"destinationAddress": {
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"shipping": {
"mode": "selected",
"signatureType": "Signature",
"serviceCode": "FEDEX_GROUND"
},
"items": [{ "inventoryItemId": "jk7inv456" }]
}
Creates an outbound request to ship one or more inventory items out of vault for an FBO account.
Every item must currently belong to the FBO account and be in an
in_vault status. The request is
created with a pending_review status and awaits vault staff approval.
Creating a request does not create an outbound shipment. List Outbound
Shipments stays empty until staff approve the request and
operators pick the items. Requested items remain in_vault; Get Inventory
Item exposes openOutboundRequestId so you can see they are
requested without implying they have left the vault. Status becomes pending_outbound at pick.
You can optionally send a destination and a shipping preference. Omitting shipping defaults to the
cheapest insured service so you never have to quote first. Prices are never accepted from the
client — the backend re-quotes after the request is created.
Permission: outbound_requests:create
Request body
string
required
ID of the FBO account requesting the outbound shipment.
string
Optional free-text note describing the request.
object
Carrier-shaped destination for the shipment. If omitted, vault staff can set it later. A quote is
resolved shortly after create only when this address is present.
Show address properties
Show address properties
object
How the vault should choose a carrier service. Omit to default to
mode: "cheapest" and
signatureType: "NoSignature".Show shipping properties
Show shipping properties
string
cheapest (default) picks the lowest-cost insured service. selected names a specific
service via serviceCode.string
One of
NoSignature (default), Signature, AdultSignature, or DirectSignature.string
Carrier service code to request, such as
FEDEX_GROUND. Required when mode is selected;
must be omitted when mode is cheapest.array
required
The inventory items to include — at least one. Each entry contains:
inventoryItemId(string, required) — ID of the inventory item to ship out.
inventoryItemId values must be unique within the request.{
"fboAccountId": "m97fbo456",
"notes": "Ship to primary address",
"destinationAddress": {
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"items": [{ "inventoryItemId": "jk7inv456" }]
}
{
"fboAccountId": "m97fbo456",
"destinationAddress": {
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"shipping": {
"mode": "selected",
"signatureType": "Signature",
"serviceCode": "FEDEX_GROUND"
},
"items": [{ "inventoryItemId": "jk7inv456" }]
}
Response
Returns the created outbound request with its line items.shipping is always present — omitted
input is stored as { "mode": "cheapest", "signatureType": "NoSignature" }. The billable quote
is filled in shortly after when a destinationAddress was sent; poll Get Outbound
Request to read it.
{
"data": {
"id": "jd7abc123xyz",
"fboAccountId": "m97fbo456",
"organizationId": "k57orgxyz",
"status": "pending_review",
"totalItems": 2,
"approvedBySystem": false,
"notes": "Ship to primary address",
"destinationAddress": {
"name": "Jane Doe",
"street1": "123 Main St",
"city": "Dallas",
"state": "TX",
"zip": "75001",
"country": "US"
},
"shipping": {
"mode": "cheapest",
"signatureType": "NoSignature"
},
"outboundShipmentIds": [],
"items": [
{
"id": "j970item123",
"outboundRequestId": "jd7abc123xyz",
"productId": "jh7prod123",
"inventoryItemId": "jk7inv456",
"createdAt": "2025-06-15T09:00:00Z"
}
],
"createdAt": "2025-06-15T09:00:00Z"
}
}
mode: "selected" without serviceCode, or mode: "cheapest" with serviceCode, returns 400.
The stored object uses requestedServiceCode (not the input’s serviceCode) when a service was
named.