Get Billing & Void Status

请求

Retrieve the carrier billing state and void state of a previously purchased label, looked up by tracking number.

安全

BearerAuth or ApiTokenAuth

查询

tracking_codestring必需

Tracking number of the shipment to look up.

示例:tracking_code=1ZXXXXXXXXXXXXX

curl -i -X GET \
  'https://ps-api.shipsaving.com/api/shipments/status?tracking_code=1ZXXXXXXXXXXXXX' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

响应

Shipment status retrieved successfully

正文application/json

tracking_codestring

Tracking number of the matched shipment, echoed from the stored shipment record.

示例:"1ZXXXXXXXXXXXX"

bill_statusstring

Carrier billing state.

pending — not yet reconciled; the state of a newly purchased label
ready — queued for reconciliation
completed — reconciled; bill_rate is final

示例:"completed"

bill_ratenumber or null, (double)

Amount actually billed by the carrier, in USD, always to two decimal places.

示例:22.68

void_statusstring or null

Void state of the label.

示例:""

adjust_timestring or null, (date-time)

Timestamp of the most recent billing adjustment on this shipment, as an ISO-8601 UTC instant with second precision. null when the shipment has never been adjusted.

示例:"2026-07-29T07:00:05Z"

Response

{
  "tracking_code": "1ZXXXXXXXXXXXXX",
  "bill_status": "completed",
  "bill_rate": 22.68,
  "void_status": "",
  "adjust_time": "2026-07-29T07:00:05Z"
}