Quick Start Guide
Your First API Call in 5 Minutes
Get up and running with the 3PL SHIP API. Create orders, track shipments, and manage inventory with simple REST API calls.
1
Get Your API Keys
- Log in to your 3PL SHIP Dashboard
- Navigate to Settings → API Keys
- Click "Generate New API Key"
- Copy your API key (starts with
zl_live_for production orzl_test_for testing)
Security Warning
Never share your API key publicly or commit it to version control. Treat it like a password.
2
Make Your First Request
List all orders from your account using your preferred language:
bash
curl https://app.3plship.com/api/v1/orders \
-H "Authorization: Bearer zl_live_your_api_key_here" \
-H "Content-Type: application/json"3
Create Your First Order
Send a fulfillment order to 3PL SHIP:
bash
curl -X POST https://app.3plship.com/api/v1/orders \
-H "Authorization: Bearer zl_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"order_number": "ORDER-12345",
"customer_id": "cust_abc123",
"shipping_address_id": "addr_xyz789",
"line_items": [
{
"product_id": "prod_supp001",
"quantity": 2,
"unit_price": 29.99
}
],
"shipping_method": "standard"
}'Success Response:
{
"success": true,
"data": {
"id": "ord_abc123",
"order_number": "ORDER-12345",
"status": "pending",
"created_at": "2025-01-15T10:30:00.000Z"
},
"meta": {
"timestamp": "2025-01-15T10:30:00.000Z",
"requestId": "req_xyz123",
"version": "v1"
}
}4
Track Your Order
Check the status and tracking information:
bash
curl https://app.3plship.com/api/v1/orders/ord_abc123 \
-H "Authorization: Bearer zl_live_your_api_key_here"Need help getting started?