Understand Shipment Tracking REST API responses

Shipment Tracking returns a normalized tracking item after a create, list, retrieve, or delete request. The response contains the customer-facing provider and tracking link rather than the internal order metadata used by the extension.

Note:

Store the returned tracking_id when your integration may need to retrieve or delete the item later. The tracking number is not the REST resource identifier.

Example response

↑ Back to top

This example shows the primary fields returned for a predefined USPS tracking item.

{
  "tracking_id": "7f4978c390ee633c6294ae0f258656f9",
  "tracking_provider": "USPS",
  "tracking_link": "https://tools.usps.com/tracking/9400111899560000000000",
  "tracking_number": "9400111899560000000000",
  "date_shipped": "2026-07-10"
}

Response properties

↑ Back to top

Property	Type	Description
`tracking_id`	string	A read-only identifier generated for the tracking item.
`tracking_provider`	string	The formatted provider name shown to customers.
`tracking_link`	URL	The generated carrier link with order-specific values substituted.
`tracking_number`	string	The saved carrier tracking number.
`date_shipped`	date	The shipped date formatted as `YYYY-MM-DD`.

A custom-provider item uses the same response shape. Shipment Tracking places the custom provider name in tracking_provider and expands the custom link into tracking_link.

List, retrieve, and delete items

↑ Back to top

Replace <order_id> and <tracking_id> with IDs from your store and a previous API response.

Operation	Method and path
List tracking items	`GET /orders/<order_id>/shipment-trackings`
Retrieve one item	`GET /orders/<order_id>/shipment-trackings/<tracking_id>`
Delete one item	`DELETE /orders/<order_id>/shipment-trackings/<tracking_id>`

Prefix each path with /wp-json/wc-shipment-tracking/v3. List and retrieve requests require permission to read orders. Delete requests require permission to delete the order resource. A successful delete returns the tracking item that was removed.

Handle missing resources

↑ Back to top

The API returns HTTP 404 when the order does not exist or when the tracking ID is not attached to that order. Treat tracking IDs as order-specific: an ID returned for one order cannot be retrieved through another order’s endpoint.

Use the links included in the full REST response when your client supports HATEOAS navigation. They identify the item, its collection, and the related order endpoint.