📦 Track123 Shopify App API Documentation

Overview

Track123 provides a simple and reliable API to allow developers to retrieve order and shipment tracking information from their connected Shopify store. This API returns order metadata, fulfillment information, tracking details, and more.

🔗 Endpoint

GET

https://shp.track123.com/shopify/api/v1/{uuid}/orders/{orderId}.json

Path Parameters

Parameter	Description
`uuid`	Your store’s myshopify subdomain. For example, `yourstore` in `yourstore.myshopify.com`.
`orderId`	The Shopify Order ID (not the order number).

🔐 Authentication

You must include an API Key in the request header.

Required Headers

Header	Value
`X-Api-Key`	Your API key (get it from the app settings)
`Content-Type`	`application/json`

You can find your API key in the Track123 App by navigating to:
Settings → General → API & Webhook

📥 Request Example

GET /shopify/api/v1/yourstore/orders/5893717688379.json HTTP/1.1 
Host: shp.track123.com 
X-Api-Key: your-api-key 
Content-Type: application/json

✅ Response Structure

{
	"order": {
		"order_name": "#1012",
		"order_number": "1012",
		"order_id": "5918868635707",
		"order_tag": "",
		"tracking_link": "https://demo.myshopify.com/apps/track123",
		"order_create_at": "2025-07-16T03:18:24Z",
		"order_update_at": "2025-07-16T03:19:51Z",
		"order_closed_at": "2025-07-16T03:19:48Z",
		"status": "ready",
		"customer": {
			"name": "Russell Winfield",
			"email": "Russel.winfield@example.com",
			"phone": "+16135550135"
		},
		"shipping_address": {
			"country": "Canada",
			"province": "Ontario",
			"city": "Toronto",
			"address": "105 Victoria St",
			"phone": "+16135550135"
		},
		"fulfillments": [{
			"create_at": "2025-07-16T03:19:47Z",
			"id": "5413844713531",
			"tracking_company": "YunExpress",
			"tracking_number": "YT2516700702469873",
			"carrier_code": "yunexpress",
			"courier": {
				"query_link": "https://www.yuntrack.com/Track/Detail/YT2516700702469873",
				"country_code": "CN",
				"phone": "+86 400-8575-500",
				"code": "yunexpress",
				"name": "YunExpress",
				"home_page": "http://www.yunexpress.com/",
				"pic_url": "https://myqcloud.com/provider/yunexpress.gif"
			},
			"transit_status": "Delivered",
                        "transit_sub_status": "Delivered to the front door",
			"last_event": "Delivered, In/At Mailbox",
			"last_event_time": "2025-06-19T09:23:00Z",
			"line_items": [{
				"id": "16496732078139",
				"product_id": "7405675249723",
				"variant_id": "42240018219067",
				"title": "The Multi-location Snowboard",
				"sku": "",
				"variant_title": null,
				"quantity": 1
			}],
			"tracking_details": [{
					"event_time": "2025-07-05 15:03:59",
					"event_time_utc": "2025-07-05 19:03:59",
					"event_detail": "Delivered, Left on porch. Signature Service not requested.",
					"event_location": "Warsaw, KY, US"
				},
				{
					"event_time": "2025-07-05 05:56:00",
					"event_time_utc": "2025-07-05 09:56:00",
					"event_detail": "On FedEx vehicle for delivery",
					"event_location": "INDEPENDENCE, KY, US"
				},
				{
					"event_time": "2025-07-05 05:47:00",
					"event_time_utc": "2025-07-05 09:47:00",
					"event_detail": "At local FedEx facility",
					"event_location": "INDEPENDENCE, KY, US"
				},
				{
					"event_time": "2025-07-03 18:40:00",
					"event_time_utc": "2025-07-03 22:40:00",
					"event_detail": "Arrived at FedEx location",
					"event_location": "INDEPENDENCE, KY, US"
				},
				{
					"event_time": "2025-07-03 09:54:09",
					"event_time_utc": "2025-07-03 15:54:09",
					"event_detail": "On the way",
					"event_location": "NASHVILLE, TN, US"
				},
				{
					"event_time": "2025-07-02 21:45:01",
					"event_time_utc": "2025-07-03 03:45:01",
					"event_detail": "On the way",
					"event_location": "LAWRENCE, MS, US"
				},
				{
					"event_time": "2025-07-02 09:39:20",
					"event_time_utc": "2025-07-02 14:39:20",
					"event_detail": "Departed FedEx location",
					"event_location": "CYPRESS, TX, US"
				},
				{
					"event_time": "2025-07-02 06:01:45",
					"event_time_utc": "2025-07-02 11:01:45",
					"event_detail": "Shipment arriving On-Time",
					"event_location": "CYPRESS,TX US"
				},
				{
					"event_time": "2025-06-30 03:42:00",
					"event_time_utc": "2025-06-30 08:42:00",
					"event_detail": "Shipment information sent to FedEx",
					"event_location": "US"
				}
			],
			"last_mile_tracking_supported": true,
			"last_mile_info": {
				"lm_track_no": "2791659144",
				"lm_track_no_provider_code": "fedex",
				"lm_track_no_provider_name": "FedEx",
				"courier_logo": "https://myqcloud.com/provider/fedex.gif",
				"query_link": "",
				"courier_home_page": "http://www.fedex.com/",
				"details": [{
						"event_time": "2025-07-02 21:45:01",
						"event_time_utc": "2025-07-03 03:45:01",
						"event_detail": "On the way",
						"event_location": "LAWRENCE, MS, US"
					},
					{
						"event_time": "2025-07-02 09:39:20",
						"event_time_utc": "2025-07-02 14:39:20",
						"event_detail": "Departed FedEx location",
						"event_location": "CYPRESS, TX, US"
					},
					{
						"event_time": "2025-07-02 06:01:45",
						"event_time_utc": "2025-07-02 11:01:45",
						"event_detail": "Shipment arriving On-Time",
						"event_location": "CYPRESS,TX US"
					},
					{
						"event_time": "2025-06-30 03:42:00",
						"event_time_utc": "2025-06-30 08:42:00",
						"event_detail": "Shipment information sent to FedEx",
						"event_location": "US"
					}
				]
			},
		}]
	},
	"store": {
		"name": "demo-1002",
		"url": "demo-1002.myshopify.com"
	}
}

🧾 Field Descriptions

Top-Level: `order`

Field	Type	Description
`order_name`	string	Display order number (e.g., `#1011`)
`order_number`	string	Numeric Shopify order number
`order_id`	string	Shopify internal order ID
`tracking_link`	string	Track123 branded tracking page URL
`order_create_at`	datetime	Order creation time (ISO 8601)
`order_update_at`	datetime	Last order update time
`order_closed_at`	datetime/null	Order closure time (if available)
`status`	string	Overall order status (`ordered`, `delivered`, etc.)

`customer`

Field	Type	Description
`name`	string	Customer full name
`email`	string	Customer email
`phone`	string	Customer phone (optional)

`shipping_address`

Field	Type	Description
`country`	string	Country name
`province`	string	State or province
`city`	string	City
`address`	string	Street address
`phone`	string	Phone (optional)

`fulfillments`

Array of fulfillment shipments.

Field	Type	Description
`tracking_company`	string	Courier name in Shopify
`tracking_number`	string	Tracking number
`carrier_code`	string	Carrier code in Track123 (e.g., fedex, ups)
`transit_status`	string	Current delivery status
`last_event`	string	Most recent tracking update
`last_event_time`	datetime	Timestamp of last event

Courier

Field	Type	Description
code	string	Carrier code in Track123 (e.g., fedex, ups)
name	string	Carrier name in Track123 (e.g., fedex, ups)
home_page	string	The official homepage of the carrier
query_link	string	The carrier’s official tracking URL with the tracking number pre-filled.
pic_url	string	Carrier logo link

`line_items`

List of products in this fulfillment.

Field	Type	Description
`title`	string	Product title
`quantity`	int	Quantity shipped

`tracking_details`

List of tracking history events.

Field	Type	Description
`event_time`	datetime	Local time of the event
`event_detail`	string	Description of the event
`event_location`	string	Location where the event occurred

📘 Status Reference

Possible values for transit_status include:

Pending
Info received
In transit
Out for delivery
Delivered
Exception
Failed attempt
Expired

Possible values for transit_sub_status include:

🚫 Pending

No record
Unfulfilled
Fulfilled

📩 Info Received

Info received

🚚 In Transit

In transit
Processed through sort facility
Custom clearance completed
Picked up by the carrier
Forwarded to the airline
Arrived at destination country
Arrived at service point
Departed from the airport

🛵 Out for Delivery

Out for delivery
Waiting for pickup
Being redelivered

📦 Delivered

Delivered
Package collected by customer
Sign by customer
Delivered to the front door

❌ Failed attempt

Invalid address
Customer was not available
Failed to contact
Failed attempt

⚠️ Exception

Unclaimed
Retained by customs
Shipment damaged/lost
Shipment cancelled
Refused by customer
Returned to sender
Returning to sender
Other