Skip to main content

Submit Shipment Tracking

POST 
/api/amazon/:integrationInstance/draft-inbound-plans/:draft_inbound_plan/shipments/:plan_shipment/tracking

Submit non-partnered-carrier (nPCP) tracking for a shipment. Provide exactly ONE of:

  • box_tracking — per-box tracking IDs (small parcel / SPD)
  • freight_bill_numbers — freight bill numbers (LTL/FTL)
Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Sending both (or neither) is a 422.

Fields:

  • box_tracking (array, min 1, required without freight_bill_numbers, prohibits freight_bill_numbers):
    • box_tracking.*.box_id (integer, required) — local box ID; must belong to this shipment/plan and must already have an Amazon box ID (submit packing information first — 422 otherwise)
    • box_tracking.*.tracking_id (string, required, max 255) — carrier tracking number
  • freight_bill_numbers (array of strings, min 1, max 255 each, required without box_tracking)

The tracking is persisted locally first (boxes merged into the shipment's tracking_summary.boxes; freight bill numbers stored on the shipment), then a tracked background job submits it to Amazon via the FBA Inbound v2024-03-20 updateShipmentTrackingDetails operation. Returns { "data": { "tracked_job_log_id": <id> } } immediately; progress is visible via the tracked job log endpoints.

Tracked job name: Update FBA Shipment Tracking: {plan name}. The job starts an asynchronous Amazon operation; the TrackedJobLog is completed (or failed) by the amazon_inbound_operations poller (a background job), which refreshes the shipment's tracking_summary from Amazon via getShipment on success.

422 conditions:

  • neither or both of box_tracking / freight_bill_numbers provided
  • a box_tracking.*.box_id does not belong to this shipment or plan
  • a box has no Amazon box ID yet (packing information not submitted)

Returns 404 when the shipment does not belong to the draft inbound plan.

LTL example body:

{
  "freight_bill_numbers": ["FBN-2026-0001", "FBN-2026-0002"]
}

Request​

Responses​

OK

Response Headers
    Content-Type