API Overview

The TrackMy.Shop API allows you to manage orders, stages, and flows from your own applications, custom integrations, or automation tools.

Authentication

API requests require an API key. Generate keys in Settings → API Keys.

Include your key in the Authorization header:

Authorization: Bearer sk_live_your_key_here

Base URL

All API endpoints use the base URL:

https://trackmy.shop/api/v1

Available Endpoints

Orders

Method	Path	Description
POST	/orders	Create a new order
GET	/orders	List orders (paginated, filterable)
GET	/orders/:id	Get a single order
PATCH	/orders/:id	Update order fields
POST	/orders/:id/move	Move order to a stage
POST	/orders/:id/triage	Assign order to a flow
POST	/orders/:id/archive	Archive or unarchive an order

Stages & Flows

Method	Path	Description
GET	/stages	List stages
GET	/flows	List flows (order types)

Response Format

All responses use a standard envelope:

{ "success": true, "data": { ... } }

List endpoints include pagination:

{
  "success": true,
  "data": [...],
  "pagination": { "total": 42, "page": 1, "limit": 20, "hasMore": true }
}

Errors return a message and code:

{ "error": "Description of what went wrong", "code": "VALIDATION_ERROR" }

Interactive API Reference

Explore and test all endpoints interactively at /api/docs.

Rate Limits

API requests are limited based on your plan. Check your current usage in Settings → API Keys.