Getting Started with WhereParcel API
WhereParcel provides a unified API to track parcels from over 500 carriers worldwide. Whether you’re building an e-commerce platform, logistics dashboard, or customer notification system, our API makes it simple to get real-time tracking data.
Prerequisites
Before you begin, make sure you have:
- A WhereParcel account (sign up here)
- An API key from your dashboard
- Basic knowledge of REST APIs
Step 1: Get Your API Key
After signing up, navigate to the Dashboard and create a new API key. Your key will look something like this:
wp_live_a1b2c3d4e5f6g7h8i9j0
Keep this key secure and never expose it in client-side code.
Step 2: Make Your First Request
Here’s how to track a parcel using our API:
curl -X POST https://api.whereparcel.com/v2/track \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY" \
-d '{
"trackingItems": [{ "carrier": "kr.cjlogistics", "trackingNumber": "1234567890" }]
}'
Step 3: Parse the Response
The API returns a standardized tracking response regardless of the carrier:
{
"success": true,
"data": {
"carrier": "kr.cjlogistics",
"trackingNumber": "1234567890",
"status": "in_transit",
"estimatedDelivery": "2026-02-05",
"events": [
{
"timestamp": "2026-02-01T10:30:00Z",
"status": "picked_up",
"location": "Seoul Sorting Center",
"description": "Package picked up from sender"
}
]
}
}
What’s Next?
Now that you’ve made your first request, explore these topics:
- Authentication Guide - Learn about API key security best practices
- Webhook Setup - Get real-time delivery notifications
- Carrier List - See all 500+ supported carriers
Happy tracking!