REST API
The OrderTrackify REST API provides programmatic access to shipment tracking, store management, and billing. Base URL: https://api.ordertrackify.com/api/v1
Articles
- Quick StartRegister or sign in, obtain JWT access and refresh tokens, and make your first merchant-scoped REST API request.→
- AuthenticationThe API uses JWT bearer tokens. Register → login → receive access + refresh tokens. Access tokens expire after 15 minutes. Use the refresh e…→
- Orders & Plugin APIList merchant orders and reference WooCommerce plugin routes, including plan/quota access payloads, merchant-only shipment holds, access-blo…→
- Shipments APIList and inspect shipments by carrier status or operational tracking state, handle access-blocked re-polls, query analytics/sync health, and…→
- Stores APIManage connected stores programmatically. List stores, view connection status, and manage store settings.→
- Public Tracking APIRetrieve public shipment status by preferred opaque tracking token or the rate-limited legacy tracking-number route.→
- Carriers APIList the curated carrier selector registry and understand how polling resolves exact provider codes across the complete bundled TrackingMore…→
- Billing APIRead plan/access state and use quote-bound start_paid_plan or full-period renew_period previews to restore exhausted Stripe-backed allowance…→
- Webhook DeliveryConfigure outbound webhooks to receive real-time shipment status updates. All payloads are HMAC-SHA256 signed for verification.→
- Notification Catch-up APIConfigure delivered-email catch-up limits and understand how historical, superseded, and stale shipment notifications are suppressed.→
- Error HandlingHandle validation/auth failures, 402 shipment-access or billing-payment responses, 409 renewal conflicts, rate limits, and transient server …→