Skip to main content

Shipment Status

GET /api/3pl/{company}/status

Check whether a shipment is still being created or view its carrier tracking status.

curl --get "https://www.dyli.io/api/3pl/$DYLI_3PL_COMPANY/status" \
  -H "x-api-key: $DYLI_3PL_API_KEY" \
  --data-urlencode "shipment_id=0x..."

shipment_id accepts:

  • the tracking_key returned by /order;
  • the original payment txHash; or
  • the Easyship shipment_id.

Aliases are txHash and tx_hash.

Pending​

{
  "success": true,
  "pending": true,
  "insurance": true,
  "incoterms": "DDU",
  "status": "pending",
  "shipment_id": "0x...",
  "tracking_key": "0x...",
  "easyship_shipment_id": null,
  "attempts": 1,
  "retryable": true,
  "next_retry_at": "2026-07-18T14:30:00.000Z",
  "last_attempt_at": "2026-07-18T14:29:30.000Z",
  "message": "Shipment is pending Easyship creation."
}

Tracking Available​

{
  "insurance": true,
  "incoterms": "DDU",
  "shipments": [
    {
      "easyship_shipment_id": "ESUS123456789",
      "status": "in_transit",
      "tracking_number": "ESUS123456789",
      "external_tracking": "1Z...",
      "tracking_page_url": "https://www.trackmyshipment.co/shipment-tracking/ESUS123456789",
      "eta_date": "2026-07-22",
      "checkpoints": []
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "next": null,
      "count": 1
    }
  }
}

Poll no faster than once every 30 seconds while a shipment is pending. Once tracking is available, use carrier checkpoints or the returned tracking page.