Skip to main content

​
Step 1: Get Your API Key

1

Sign in to the Dashboard

Go to dashboard.crbtrack.com and sign in with your credentials.
2

Navigate to API Keys

Click on Settings → API Keys in the sidebar.
3

Generate a New Key

Click Generate New API Key. Choose a name like “My Integration” and select the countries you’ll be shipping to.
4

Copy Your Key

Your API key will be displayed only once. Copy it and store it securely.
Never share your API key or commit it to version control. Use environment variables instead.

​
Step 2: Test with Sandbox

Before going live, test your integration using the sandbox environment.
Sandbox API keys start with pk_test_ and production keys start with pk_live_.

​
Using Postman

Download our pre-configured Postman collection to test all API endpoints:

Download Postman Bundle

ZIP file with collection, environment, and setup instructions
 Quick setup:
  1. Download and extract the ZIP file
  2. Open Postman and click “Import”
  3. Drag both JSON files into the import dialog
  4. Select the “CRBTrack API” environment (gear icon)
  5. Set your apiKey variable
  6. Start testing - tracking numbers auto-chain between requests!
# Sandbox URL
https://sandbox.crbtrack.com

# Production URL (use after testing)
https://api.crbtrack.com

​
Step 3: Create Your First Order

curl -X POST https://sandbox.crbtrack.com/api/v1/orders/create \
  -H "X-API-Key: pk_test_your_sandbox_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "idempotencyKey": "my-first-order-001",
    "sender": {
      "fullName": "John Smith",
      "phone": "+1 305-555-0123",
      "email": "[email protected]",
      "address": {
        "line1": "1234 Main Street",
        "city": "Miami",
        "state": "FL",
        "zipCode": "33101",
        "country": "US"
      }
    },
    "receiver": {
      "fullName": "María García",
      "phone": "+593 99 123 4567",
      "email": "[email protected]",
      "nationalId": "1234567890",
      "idType": "cedula",
      "address": {
        "line1": "Av. 9 de Octubre 123",
        "city": "Guayaquil",
        "province": "Guayas",
        "zipCode": "090101",
        "country": "EC",
        "deliveryInstructions": "Dejar en recepción"
      }
    },
    "parcelDetails": {
      "weightLbs": 2.5,
      "lengthCm": 30,
      "widthCm": 20,
      "heightCm": 15,
      "declaredValue": 149.99,
      "currency": "USD"
    },
    "customsInfo": {
      "description": "Electronics - Mobile Phone Accessories",
      "hsCode": "8517.62"
    }
  }'

​
Step 4: Check the Response

A successful response looks like this: 
{
  "success": true,
  "parcel": {
    "id": "cl123abc456def",
    "trackingNumber": "SBECUSD123456789",
    "status": "LABEL_GENERATED",
    "labelUrl": "https://labels.sandbox.crbtrack.com/SBECUSD123456789.pdf",
    "createdAt": "2024-12-21T10:30:00Z"
  }
}
In sandbox mode, tracking numbers start with SB to indicate they’re test shipments.

​
Step 5: Download the Label

Use the labelUrl from the response to download the shipping label: 
curl -O "https://labels.sandbox.crbtrack.com/SBECUSD123456789.pdf"

​
Step 6: Track the Parcel

Track your parcel using the tracking number: 
curl https://sandbox.crbtrack.com/api/v1/tracking/SBECUSD123456789 \
  -H "X-API-Key: pk_test_your_sandbox_key_here"

​
Next Steps

Submit a Manifest

Group parcels into a shipment with an AWB

Set Up Webhooks

Receive real-time status updates

Handle Errors

Learn about error codes and retry strategies

Go to Production

Complete the full shipping workflow