Create Outbound Shipment

Creates an outbound shipment to ship one or more inventory items out of the vault for an FBO account. Every item must currently belong to the FBO account and be in an in_vault status. The response returns a status of created. Cancel is available while the status is created. Requested items remain in_vault. Get Inventory Item sets openOutboundRequestId to this shipment’s id. Send a destination and a shipping preference. shipping.mode is cheapest or selected. selected also needs serviceCode. The shipment is insured, so set signatureType to Signature, AdultSignature, or DirectSignature. Read shipping.quote from get after create. Permission: outbound_shipments:create

Request body

string

required

ID of the FBO account requesting the outbound shipment.

string

Optional free-text note describing the shipment.

object

Where the package goes.

Show address properties

string

required

Street address line 1.

string

required

City.

string

required

State or province.

string

required

Postal code.

string

required

Country code (for example US).

string

Street address line 2.

string

Recipient name.

string

Company or organization name.

string

Contact phone.

string

Contact email.

object

How to choose a carrier service. signatureType is Signature, AdultSignature, or DirectSignature.

Show shipping properties

string

cheapest uses the lowest-cost insured service. selected names a specific service via serviceCode.

string

One of Signature, AdultSignature, or DirectSignature.

string

Carrier service code to request, such as FEDEX_GROUND. Required when mode is selected.

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 shipment.

{
  "fboAccountId": "m97fbo456",
  "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": "Signature" },
  "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 shipment with its line items.

{
  "data": {
    "id": "jd7abc123xyz",
    "fboAccountId": "m97fbo456",
    "organizationId": "k57orgxyz",
    "status": "created",
    "totalItems": 1,
    "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": "Signature"
    },
    "packages": [],
    "items": [
      {
        "id": "j970item123",
        "outboundShipmentId": "jd7abc123xyz",
        "productId": "jh7prod123",
        "inventoryItemId": "jk7inv456",
        "createdAt": "2025-06-15T09:00:00Z"
      }
    ],
    "createdAt": "2025-06-15T09:00:00Z"
  }
}

This endpoint supports the Idempotency-Key header.

Overview

Entities

Organizations

FBO Accounts

Products

Inventory

Inbound Shipments

Transfers

Outbound Shipments

Webhooks

Statements

Request body

Response

​Request body

​Response

Request body

Response