Get Shipping Channel

Retrieves a specific shipping channel by ID.

Endpoint

GET /v1/shipping-channels/{id}

Authentication

API key required. Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Path Parameters

Parameter	Type	Description
id	string	The ID of the shipping channel to retrieve.

Response

200 OK

{
  "data": {
    "id": "ch_123456",
    "name": "DHL Channel",
    "provider": "dhl",
    "status": "active",
    "created_at": "2025-03-26T12:00:00Z",
    "updated_at": "2025-03-26T12:00:00Z"
  }
}

Error Responses

Status Code	Description
401	Unauthorized - Invalid or missing API key
403	Forbidden - You don't have permission to access this shipping channel
404	Not Found - The specified shipping channel could not be found
429	Too Many Requests - Rate limit exceeded
500	Server Error - Something went wrong on our end

Example Request

cURL

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

PHP

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

$response = $client->request('GET', 'https://api.shipping-channels.com/v1/shipping-channels/ch_123456', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

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

JavaScript

fetch('https://api.shipping-channels.com/v1/shipping-channels/ch_123456', {
  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));

Security Considerations

• The shipping channel's sensitive credentials (like API keys) are never returned in full; they are masked with dots (••••)
• You can only access shipping channels that belong to your account
• All requests should be made over HTTPS to ensure data security