Skip to content
API Reference
/
/
Query tracking status by...

ShipSaving New API (v2)

Overview
License
Apache 2.0
Languages
Servers
Production server
https://x-api.shipsaving.com

Authentication

Operations

Shipment

Operations

Tracking

Operations

Query Shipment Tracking Status by `platform_uk_id`

Request

Indicates the current location or state of a package within the supply chain (e.g., in_transit, out for delivery). Use the tracking status object to monitor shipment progress. In test mode, this API will return fixed mock data to facilitate testing and integration validation.

Security
BearerAuth
Query
platform_uk_idstring(PlatformUkId)required

A unique identifier provided by the calling party (e.g., the caller’s order number). Each platform_uk_id must correspond to exactly one shipment and cannot be reused across multiple shipments.

Example: platform_uk_id=platformUkId175377917713
curl -i -X GET \
  'https://x-api.shipsaving.com/api/shipment/tracking_by_platform_uk_id?platform_uk_id=platformUkId175377917713' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json:
codestring

API response code; "ok" indicates success.

Example: "ok"
msgstring

Human-readable response message.

Example: "ok"
dataobject(TrackingData)

This is the latest tracking record.

Response
application/json:
{
  "code": "ok",
  "msg": "ok",
  "data": {
    "scanned_time": "2025-08-26T22:37:27Z",
    "status": "in_transit",
    "message": "USPS in possession of item",
    "location": { … },
    "return_to_sender": true,
    "first_scan_date": "2025-11-14T14:07:33Z",
    "first_scan_description": "Package is in transit to a UPS facility",
    "first_scan_location": { … },
    "tracking_events": [ … ]
  }
}

Query tracking status by tracking no

Request

Retrieves the shipment’s tracking status, event history, estimated delivery date, and associated origin/destination location details as reported by the carrier.

Security
BearerAuth
Query
tracking_nostring(TrackingNo)required

The carrier-specific tracking number that can be used to track the Shipment. A value will only be returned if the Rate is for a trackable Shipment and if the Transactions has been processed successfully.

Example: tracking_no=9234690381085700XXXXX
carrier_codestring(EPTrackingCarrierCodeEnum)required
Enum"USPS""UPS""AMAZON_SHIPPING"
Example: carrier_code=USPS
curl -i -X GET \
  'https://x-api.shipsaving.com/api/shipment/tracking_by_tracking_no?tracking_no=9234690381085700XXXXX&carrier_code=USPS' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
codestring

API response code; "ok" indicates success.

Example: "ok"
msgstring

Human-readable response message.

Example: "ok"
dataobject(EPTrackingData)

This is the latest tracking record.

Response
application/json
{
  "code": "ok",
  "msg": "ok",
  "data": {
    "status": "in_transit",
    "message": "USPS in possession of item",
    "estimate_delivery_date": "2025-08-26 22:37:27",
    "original_tracking_location": { … },
    "destination_tracking_location": { … },
    "first_scan_date": "2025-11-14T14:07:33Z",
    "first_scan_description": "Package is in transit to a UPS facility",
    "first_scan_location": { … },
    "scanned_time": "2025-11-14T14:07:33Z",
    "location": { … },
    "tracking_events": [ … ]
  }
}

Query tracking status by tracking no (with UTC offset)

Request

Retrieves the current shipment tracking event, first scan tracking event, and the complete tracking event history as reported by the carrier.

Compared to /api/shipment/tracking_by_tracking_no, this endpoint returns all tracking event timestamps in ISO 8601 format with the UTC offset included, allowing clients to accurately interpret local event times across different time zones.

Security
BearerAuth
Query
tracking_nostringrequired

tracking number

Example: tracking_no=940013620842281000000
carrier_codestringrequired

carrier code

Example: carrier_code=USPS
curl -i -X GET \
  'https://x-api.shipsaving.com/api/shipment/direct/tracking_by_tracking_no?tracking_no=940013620842281000000&carrier_code=USPS' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
codestring

API response code; "ok" indicates success.

Example: "ok"
msgstring

Human-readable response message.

Example: "ok"
dataobject(TrackingDataWUtcOffset)

This is the latest tracking record.

Response
application/json
{
  "code": "ok",
  "msg": "ok",
  "data": {
    "status": "in_transit",
    "message": "USPS in possession of item",
    "scanned_time": "2025-12-16T10:48:28-05:00",
    "location": { … },
    "return_to_sender": true,
    "first_scan_date": "2025-11-14T14:07:33-05:00",
    "first_scan_description": "Package is in transit to a UPS facility",
    "first_scan_location": { … },
    "tracking_events": [ … ]
  }
}

Pickup

Operations

Address Validation

Operations
Copyright © 2026 ShipSaving. All Rights Reserved.