1. Home
  2. Docs
  3. Advanced Shipment Tracking for WooCommerce
  4. REST API Support

REST API Support

Shipment Tracking REST API

The shipment tracking REST API allows you to create, view, and delete individual shipment tracking.

The endpoint URL slug is /wp-json/wc/v1/orders/shipment-trackings

Shipment Tracking Properties (meta fields)

These are the available meta field that we create and can be used in the API:

ATTRIBUTE TYPE DESCRIPTION PERMISSIONS
order_id string Unique identifier for order read-only
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))  

Endpoint – Create a shipment tracking

With this endpoint you can add new tracking info to orders:

List all shipment trackings

With this endpoint you can list all tracking info added to an order. You will need to pass order id and you’ll get respond with array of tracking numbers added to that order,

Delete a shipment tracking

You can delete tracking numbers from orders, you will need to pass the order id and the tracking_id for this tracking number:

Was this article helpful to you? Yes No 1

How can we help?