The shipment tracking REST API allows you to create, view, and delete individual shipment tracking. The endpoint is /wp-json/wc-ast-pro/v3/.
| Attribute | Type | Description | |
|---|---|---|---|
| tracking_id | string | Unique identifier for shipment tracking | read-only |
| order_id | int | Unique order id | required |
| tracking_number | string | Tracking number | required |
| tracking_provider | string | Tracking provider name | |
| date_shipped | date | Date when package was shipped | |
| status_shipped | int | Change order status to “Shipped” (completed) or “Partial Shipped” – (0=no,1=shipped,2=partial shipped(if partial shipped order status is enabled)) | |
| sku | string | Line item (product) SKU | |
| qty | int | Line item (product) quantity |
POST /wp-json/wc-ast-pro/v3/orders/645/shipment-trackings
curl -X POST https://your-domain.com/wp-json/wc-ast/v3/orders/<order_id>/shipment-trackings
-u consumer_key:consumer_secret
-H "Content-Type: application/json"
-d '{
"tracking_provider": "Fedex",
"tracking_number": "12345678",
"date_shipped": "2019-03-08",//date_shipped is optional parameter
"status_shipped": 1,//status_shipped is optional parameter
"sku": "woo-beanie,Woo-beanie-logo",
"qty": "1,1",
"replace_tracking": 1,//replace_tracking is optional parameter
}'
//response example:
"Tracking ID: fb7170d97d0e628bc3b565999d07c6a9"
GET /wp-json/wc-ast-pro/v3/orders/<order_id>/shipment-trackings/<tracking-id>
curl -X GET https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings/aef9edae359ef9d610e8a330879921bc \
-u consumer_key:consumer_secret \
JSON response example:
{
"tracking_id": "aef9edae359ef9d610e8a330879921bc",
"tracking_provider": "USPS",
"tracking_link": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=9400116901016071541103",
"tracking_number": "9400116901016071541103",
"date_shipped": "2021-10-21",
"products_list": [
{
"product": "24",
"item_id": "170",
"qty": "5"
}
],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings/aef9edae359ef9d610e8a330879921bc"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552"
}
]
}
}
GET /wp-json/wc-ast-pro/v3/orders/<order_id>/shipment-trackings/
curl -X GET https://example.com/wp-json/wc-shipment-tracking/v3/orders/16552/shipment-trackings \
-u consumer_key:consumer_secret \
JSON response example:
[
{
"tracking_id": "aef9edae359ef9d610e8a330879921bc",
"tracking_provider": "USPS",
"tracking_link": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=9400116901016071541103",
"tracking_number": "9400116901016071541103",
"date_shipped": "2021-10-21",
"products_list": [
{
"product": "24",
"item_id": "170",
"qty": "5"
}
],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings/aef9edae359ef9d610e8a330879921bc"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552"
}
]
}
},
{
"tracking_id": "bcd6807ae41efebf629b4fff704331ea",
"tracking_provider": "USPS",
"tracking_link": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=9400116901016071541103",
"tracking_number": "9400116901016071541103",
"date_shipped": "2021-10-21",
"products_list": [
{
"product": "40",
"item_id": "169",
"qty": "2"
}
],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings/bcd6807ae41efebf629b4fff704331ea"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552"
}
]
}
}
]
DELETE /wp-json/wc-ast-pro/v3/orders/<order_id>/shipment-trackings/<tracking-id>
curl -X DELETE https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings/aef9edae359ef9d610e8a330879921bc \
-u consumer_key:consumer_secret \
JSON response example:
{
"tracking_id": "aef9edae359ef9d610e8a330879921bc",
"tracking_provider": "USPS",
"tracking_link": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=9400116901016071541103",
"tracking_number": "9400116901016071541103",
"date_shipped": "2021-10-21",
"products_list": [
{
"product": "24",
"item_id": "170",
"qty": "5"
}
],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings/aef9edae359ef9d610e8a330879921bc"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc-ast-pro/v3/orders/16552"
}
]
}
}
GET /wp-json/wc-ast-pro/v3/orders/<order_id>/shipment-trackings/providers
curl -X GET https://example.com/wp-json/wc-ast-pro/v3/orders/16552/shipment-trackings/providers \
-u consumer_key:consumer_secret \
JSON response example:
{
"Austria": {
"DPD Austria": "https://tracking.dpd.de/parcelstatus?locale=de_AT&query=%number%"
},
"Australia": {
"Australia Post": "http://auspost.com.au/track/track.html?id=%number%",
"Fastway AU": "http://www.fastway.com.au/courier-services/track-your-parcel?l=%number%"
},
"Germany": {
"UPS Germany": "http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=de_DE&InquiryNumber1=%number%"
},
"United Kingdom (UK)": {
"DHL Express UK": "http://www.dhl.com/content/g0/en/express/tracking.shtml?brand=DHL&AWB=%number%",
"DPD UK": "http://www.dpd.co.uk/tracking/trackingSearch.do?search.searchType=0&search.parcelNumber=%number%",
"UPS UK": "https://www.ups.com/track?loc=en_GB&tracknum=%number%"
},
"Global": {
"UPS Global": "http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=%number%"
},
"Sweden": {
"UPS.se": "http://wwwapps.ups.com/WebTracking/track?track=yes&loc=sv_SE&trackNums=%number%"
},
"United States (US)": {
"DHL US": "https://www.logistics.dhl/us-en/home/tracking/tracking-ecommerce.html?tracking-id=%number%",
"DHL Parcel": "https://www.logistics.dhl/us-en/home/tracking/tracking-ecommerce.html?tracking-id=%number%",
"TNT": "https://www.tnt.com/express/en_us/site/tracking.html?searchType=con&cons=%number%",
"UPS": "http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=%number%",
"USPS": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=%number%",
"UPS i-parcel": "https://tracking.i-parcel.com/?TrackingNumber=%number%"
}
}