Skip to main content

List Tracking Parcels

Retrieves a paginated list of tracking parcels for the authenticated user.

Endpoint​

GET /v1/tracking-parcels

Authentication​

API key required. Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Query Parameters​

This endpoint does not support any query parameters at the moment.

Response​

200 OK​

{
  "data": [
    {
      "id": "tp_123456",
      "tracking_number": "1234567890",
      "shipping_channel_id": "ch_123456",
      "status": "delivered",
      "reference": "order-123",
      "description": "Package for John Doe",
      "recipient": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+1234567890",
        "address": {
          "street": "123 Main St",
          "city": "New York",
          "postal_code": "10001",
          "country": "US"
        }
      },
      "created_at": "2025-04-06T10:00:00Z",
      "updated_at": "2025-04-07T12:00:00Z"
    },
    {
      "id": "tp_234567",
      "tracking_number": "0987654321",
      "shipping_channel_id": "ch_123456",
      "status": "in_transit",
      "reference": "order-456",
      "description": "Package for Jane Smith",
      "recipient": {
        "name": "Jane Smith",
        "email": "jane@example.com",
        "phone": "+1987654321",
        "address": {
          "street": "456 Oak St",
          "city": "Los Angeles",
          "postal_code": "90001",
          "country": "US"
        }
      },
      "created_at": "2025-04-07T10:00:00Z",
      "updated_at": "2025-04-07T11:00:00Z"
    }
  ]
}

Error Responses​

Status CodeDescription
401Unauthorized - Invalid or missing API key
429Too Many Requests - Rate limit exceeded
500Server Error - Something went wrong on our end

Example Request​

cURL​

curl -X GET \
  https://api.shipping-channels.com/v1/tracking-parcels \
  -H "Authorization: Bearer YOUR_API_KEY"

PHP​

<?php
$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.shipping-channels.com/v1/tracking-parcels', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
    'query' => [
        'status' => 'in_transit',
        'per_page' => 25,
    ],
]);

$data = json_decode($response->getBody(), true);

JavaScript​

fetch('https://api.shipping-channels.com/v1/tracking-parcels?status=in_transit&per_page=25', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Accept': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));