Outbound shipment

Create the shipment

To create an outbound shipment, send a request to the outbound shipments endpoint. The required fields are fboAccountId from list FBO accounts and items. Each item needs an inventory item id.

{
  "fboAccountId": "m97fbo456",
  // Where the package ships
  "destinationAddress": {
    "firstName": "Jane",
    "lastName": "Doe",
    "street1": "123 Main St",
    "city": "Dallas",
    "state": "TX",
    "zip": "75001",
    "country": "US"
  },
  // Lowest-cost insured service
  "shipping": { "service": "cheapest" },
  "items": [{ "inventoryItemId": "jk7inv456" }]
}

{
  "fboAccountId": "m97fbo456",
  // Where the package ships
  "destinationAddress": {
    "firstName": "Jane",
    "lastName": "Doe",
    "street1": "123 Main St",
    "city": "Dallas",
    "state": "TX",
    "zip": "75001",
    "country": "US"
  },
  // Carrier service from the rates endpoint
  "shipping": {
    "service": "FEDEX_GROUND"
  },
  "items": [{ "inventoryItemId": "jk7inv456" }]
}

{
  "fboAccountId": "m97fbo456",
  // Saved address from list FBO account addresses
  "destinationAddressId": "ja7addr123",
  // Carrier service from the rates endpoint
  "shipping": {
    "service": "FEDEX_GROUND"
  },
  "items": [{ "inventoryItemId": "jk7inv456" }]
}

The response returns a status of created. Cancel with the cancel endpoint while the status is created.

Review at the vault

Once your request has begun to process, the status becomes processing. An item can become pending_outbound. That change sends no webhook. Wait for the outbound_shipment.status_changed webhook.

{
  "event": "outbound_shipment.status_changed",
  "data": { "toStatus": "processing" }
}

On its way

Once the package has left, the status becomes shipped and each item becomes shipped_out. Tracking lives on packages. Wait for the outbound_shipment.status_changed webhook with a toStatus of delivered. The payload includes deliveredAt.

{
  "event": "outbound_shipment.status_changed",
  "data": { "toStatus": "delivered" }
}

Status	Meaning	Webhook
`created`	Waiting to be processed. Cancel is available.	`outbound_shipment.status_changed`
`processing`	Accepted. The package is being prepared. An item can become `pending_outbound` with no inventory webhook. Cancel is not available.	`outbound_shipment.status_changed`
`shipped`	The package has left. The items are `shipped_out`.	`outbound_shipment.status_changed`
`delivered`	The carrier reported delivery.	`outbound_shipment.status_changed`
`rejected`	Not accepted. The items stay `in_vault`.	`outbound_shipment.status_changed`
`cancelled`	Cancelled from `created`. The items stay `in_vault`.	`outbound_shipment.status_changed`

Overview

Organizations

FBO Accounts

Products

Inventory

Inbound Shipments

Transfers

Outbound Shipments

Webhooks

Statements