Shipment Tracking REST API

The AST PRO REST API lets you add, retrieve, and delete shipment tracking on WooCommerce orders programmatically. It is designed for shipping software, ERPs, OMS platforms, and 3PL providers. All endpoints require HTTPS and WooCommerce REST API credentials.

Authentication

All requests use HTTP Basic Auth with a WooCommerce Consumer Key and Consumer Secret. The account used to generate the keys must have the manage_woocommerce capability — the Administrator role has this by default; Shop Manager also works.

1. 1Go to WooCommerce → Settings → Advanced → REST API.
2. 2Click Add key.
3. 3Give it a name, select a user with Administrator or Shop Manager role, and set Permissions to Read/Write.
4. 4Click Generate API key. Copy the Consumer Key and Consumer Secret — the secret is shown only once.

Endpoints and namespaces

AST PRO exposes endpoints under two namespaces:

API fields reference

Add tracking to an order

POST /wp-json/wc-shipment-tracking/v3/orders/{order_id}/shipment-trackings/

curl -X POST https://your-domain.com/wp-json/wc-shipment-tracking/v3/orders/340/shipment-trackings/ \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
  "tracking_provider": "FedEx",
  "tracking_number": "12345678",
  "date_shipped": "08-07-2025",
  "status_shipped": 1,
  "shipping_note": "Your order has shipped."
}'

Response — returns the new tracking ID string:

"Tracking ID: fb7170d97d0e628bc3b565999d07c6a9"

Add tracking per order item (Tracking Per Item)

Use the wc-ast-pro/v3 namespace and include sku and qty to assign tracking to specific items. Requires Tracking Per Item enabled in General Settings.

POST /wp-json/wc-ast-pro/v3/orders/{order_id}/shipment-trackings

First package (partial shipment):

curl -X POST https://your-domain.com/wp-json/wc-ast-pro/v3/orders/340/shipment-trackings \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
  "tracking_provider": "USPS",
  "tracking_number": "123456",
  "date_shipped": "10-07-2025",
  "status_shipped": 2,
  "sku": "t-shirt,blue-jeans",
  "qty": "1,1",
  "shipping_note": "Partial shipment — remaining items ship soon."
}'

Second package (remaining items — use standard namespace):

curl -X POST https://your-domain.com/wp-json/wc-shipment-tracking/v3/orders/340/shipment-trackings/ \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
  "tracking_provider": "USPS",
  "tracking_number": "456879",
  "date_shipped": "12-07-2025",
  "status_shipped": 1,
  "sku": "blue-jeans",
  "qty": "1",
  "shipping_note": "Final shipment."
}'

Get tracking for an order

GET /wp-json/wc-shipment-tracking/v3/orders/{order_id}/shipment-trackings/

curl -X GET https://your-domain.com/wp-json/wc-shipment-tracking/v3/orders/340/shipment-trackings/ \
-u consumer_key:consumer_secret

Response — an array of tracking objects for the order:

[
  {
    "tracking_id": "feb9bde4475fda92cc9408607b7ecb66",
    "tracking_provider": "FedEx",
    "tracking_link": "https://www.fedex.com/fedextrack/?trknbr=12345678",
    "tracking_number": "12345678",
    "date_shipped": "2025-07-08"
  }
]

Delete tracking

DELETE /wp-json/wc-shipment-tracking/v3/orders/{order_id}/shipment-trackings/{tracking_id}

curl -X DELETE https://your-domain.com/wp-json/wc-shipment-tracking/v3/orders/340/shipment-trackings/fa61d174a05d2f34323b51d92823947d \
-u consumer_key:consumer_secret

Response:

"Tracking ID: fa61d174a05d2f34323b51d92823947d"

Get available carriers

GET /wp-json/wc-shipment-tracking/v3/orders/{order_id}/shipment-trackings/providers

curl -X GET https://your-domain.com/wp-json/wc-shipment-tracking/v3/orders/340/shipment-trackings/providers \
-u consumer_key:consumer_secret

Bulk add tracking

Add tracking for multiple orders in a single request. Each object in the shipments array follows the same field schema as the single-order endpoint.

POST /wp-json/wc-shipment-tracking/v3/orders/shipment-trackings/bulk

curl -X POST https://your-domain.com/wp-json/wc-shipment-tracking/v3/orders/shipment-trackings/bulk \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
  "shipments": [
    {
      "order_id": 677,
      "tracking_provider": "FedEx",
      "tracking_number": "FDX-1110",
      "date_shipped": "08-07-2025",
      "status_shipped": 1
    },
    {
      "order_id": 675,
      "tracking_provider": "UPS",
      "tracking_number": "UPS-2220",
      "date_shipped": "09-07-2025",
      "status_shipped": 1
    }
  ]
}'

A failed entry returns an error object for that shipment but does not stop the rest of the batch from processing.

Postman setup

1. 1Set method to POST and URL to https://your-domain.com/wp-json/wc-shipment-tracking/v3/orders/340/shipment-trackings/
2. 2Under Authorization, select Basic Auth. Enter your Consumer Key as Username and Consumer Secret as Password.
3. 3Under Headers, add Content-Type: application/json.
4. 4Under Body → Raw → JSON, paste your request body.
5. 5Click Send. A successful response includes a Tracking ID.

Error codes