1. Home
  2. Docs
  3. Advanced Shipment Tracking
  4. Tracking API Endpoint

Tracking API Endpoint

The WooCommerce REST API enable external apps use a set of API endpoints to read and write various parts of WooCommerce data. The AST plugin extends the WooCommerce Rest API and adds Shipment Tracking endpoints that allows to create, view, and delete shipment tracking information in orders.

To use the Shipment Tracking endpoint, you’ll need to generate a Rest API Key for your WooCommerce store. These API keys are the permission for external systems to connect with your store’s API.

The Shipment Tracking endpoint URL slug to use::

https://yourdomaon.com/wp-json/wc/v1/orders/shipment-trackings

Please note that shipment tracking endpoint works with WooCommerce API v1, v2, and v3. In the documentation, only v1 is shown. We are also compatible with official WooCommerce Shipment Tracking plugin REST API endpoint – wc-shipment-tracking/v3.

Available Shipment Tracking REST API endpoints

  • https://yourdomaon.com/wp-json/wc/v1/orders/shipment-trackings
  • https://yourdomaon.com/wp-json/wc/v2/orders/shipment-trackings
  • https://yourdomaon.com/wp-json/wc/v3/orders/shipment-trackings
  • https://yourdomaon.com/wp-json/wc-ast/v3/orders/shipment-trackings

Please note: AST also supports the WooCommerce Shipment Tracking API endpoint: wc-shipment-tracking

Shipment Tracking Properties

These are the available meta field that can be used when updating the Shipment Tracking API:

 

Choose the API date format from general settings:

Add Shipment tracking

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

Get shipment tracking

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 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:

Create a shipment tracking per Item

If you are using Tracking Per Item Add-on you can add tracking info using Product SKU and Quantity, for detailed instructions, check the Tracking Per Item docs

Was this article helpful to you? Yes No 1

How can we help?