Skip to Content
ShipmentsActions

Shipment Actions

Creating a Shipment

From an Order

In the portal, navigate to an order and click Create Shipment:

  1. Select a carrier account
  2. Choose a service level
  3. Enter package details (weight, dimensions)
  4. Review rates and select one
  5. Click Create Label

Via API

POST /api/shipments
Content-Type: application/json
 
{
  "orderId": "uuid-of-order",
  "carrierAccountId": "uuid-of-carrier-account",
  "service": "fedex_ground",
  "shipTo": {
    "name": "John Doe",
    "address1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US"
  },
  "weight": { "value": 2.5, "unit": "lb" },
  "dimensions": { "length": 12, "width": 8, "height": 6, "unit": "in" }
}

Voiding a Label

If a label was created in error, void it before the carrier picks up:

DELETE /api/shipments/:id/label

This cancels the label with the carrier and updates the shipment status to cancelled.

Re-syncing Tracking

Force a tracking update:

POST /api/shipments/:id/sync-tracking

Bulk Shipment Actions

Use operations to act on multiple shipments:

  • Sync All — Re-fetch tracking for all in-transit shipments
  • Export — Export shipment data to CSV
  • Update Status — Manually update status for selected shipments
TrackingCarriers