Use the providers endpoint to discover the carriers available on a store before creating a tracking item. The response groups provider names by region and maps each name to the URL format Shipment Tracking uses for customer links.
Note:
The providers endpoint is public and does not require order permissions. Its output can be changed by site customizations, so retrieve it from the same store that will receive the tracking request.
Endpoint and response
↑ Back to topSend a GET request to /wp-json/wc-shipment-tracking/v3/shipment-trackings/providers. This shortened response shows the nested object structure.
{
"Global": {
"Aramex": "https://www.aramex.com/track/track-results-new?ShipmentNumber=%1$s"
},
"United States": {
"USPS": "https://tools.usps.com/tracking/%1$s"
}
}Response structure
↑ Back to top| Level | Example | Use |
|---|---|---|
| Regional group | United States | Organizes providers in the order editor and API response. |
| Provider name | USPS | Use this value for tracking_provider when creating an item. |
| URL format | https://tools.usps.com/tracking/%1$s | Shows how Shipment Tracking builds the customer link. |
URL placeholders
↑ Back to top| Placeholder | Value |
|---|---|
%1$s | Tracking number |
%2$s | Normalized destination postcode |
%3$s | Destination country code |
Most integrations need only the provider name. Shipment Tracking applies the URL format when it prepares the tracking-item response, customer account output, and supported emails.
Use the canonical namespace
↑ Back to topThe extension registers older wc/v1 and wc/v2 aliases for compatibility, but new clients should use wc-shipment-tracking/v3. The dedicated namespace makes the extension API version explicit and avoids relying on compatibility routes.
Keep provider data current
↑ Back to top- Fetch the provider list when configuring the integration or refresh it on a reasonable schedule.
- Use the exact provider name from the response in create requests.
- Expect custom filters to add, remove, or rename providers on individual stores.
- Do not assume that a carrier available on one WooCommerce store is available on another.
When a required carrier is missing, a site administrator can add it with the wc_shipment_tracking_get_providers PHP filter or the integration can create a custom-provider tracking item.
