Get live tracking for a package

PATCH/v1/api/store/{team_slug}/shipment_package/{id}/track

v1Operation ID v1_public_shipment_package_track

Asks Shippo for the package's current tracking and returns Shippo's track object, unchanged, as data (its fields are Shippo's: carrier, tracking number, current status and history). The answer is not the usual envelope: it is { "status": 200, "success": true, "type": "<package type>", "data": {...} }, with status the integer 200 and type goshippo or external_label. Despite the PATCH method it changes nothing in YoPrint: package status isn't updated from tracking.

For a package YoPrint can't track (recorded with Record a label bought elsewhere, or whose Shippo integration is gone), data is { "packages": null }.

Permission

Any member of the team. No sales order permission is checked.

Side effects

• Calls Shippo's tracking API for a Shippo package (read-only; it buys nothing). Saves nothing.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• idstringrequired

  The package's hash id. Hash ids only: a unique key or a document number gives 404.

  • Example o6foWpSAayc79D

Request body

This operation takes no request body.

Response

200The package type and Shippo's track object, in a body of its own (not the usual envelope).

• statusintegerrequired

  Always the integer 200.

  • Always 200
• successbooleanrequired
  • Always true
• dataobjectrequired

  Shippo's track object as Shippo sent it (for example carrier, tracking_number, tracking_status, tracking_history, eta), or { "packages": null } when the package can't be tracked.

• typestringrequired

  The package type.

  • One of: "goshippo", "external_label"

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  The package isn't your team's.

  Fix

  Check the package id.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  Shippo refused the request or could not be reached. Shippo errors are not translated into 4xx replies.

  Fix

  Check the addresses, parcels and ids, then retry once. Do not loop.

Notes

• To mark a package shipped or delivered, update the package status yourself.

Related

• GETGet a package/v2/api/store/{team_slug}/v2/shipment_package/{hash_id}
• PUTChange a package's status/v2/api/store/{team_slug}/v2/shipment_package/{hash_id}

Example request

curl

curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/shipment_package/o6foWpSAayc79D/track' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "carrier": "usps",
    "eta": "2026-11-06T00:00:00Z",
    "tracking_history": [
      {
        "status": "PRE_TRANSIT",
        "status_date": "2026-11-03T09:00:00Z",
        "status_details": "Label created"
      }
    ],
    "tracking_number": "EXAMPLE-TRACKING-0001",
    "tracking_status": {
      "status": "TRANSIT",
      "status_date": "2026-11-04T09:00:00Z",
      "status_details": "In transit to destination"
    }
  },
  "status": 200,
  "success": true,
  "type": "goshippo"
}