Skip to main content

Using Shipping Channels

This guide explains how to integrate with shipping providers using Uniship.

What are Shipping Channels?​

Shipping Channels are connections to different shipping providers that allow you to:

  • Track parcels with consistent status updates
  • Maintain unified access to multiple shipping providers
  • Centralize shipping provider credentials

Available Shipping Providers​

Uniship supports multiple shipping providers. Log in to your Uniship dashboard to see all available providers, their supported regions, and configuration details.

Creating a Shipping Channel​

You can create shipping channels through the API or the dashboard. Each channel requires:

  1. A unique name for identification
  2. Provider selection (see your Uniship dashboard for available providers)
  3. Provider-specific credentials

Provider-Specific Settings​

Each shipping provider requires different credential information. See your Uniship dashboard for detailed configuration options for each provider.

All providers require authentication credentials (API keys, username/password, or OAuth tokens) and support optional settings for:

  • Sandbox/test mode
  • Default label format
  • Default service types
  • Cash on Delivery configuration

Validating Shipping Channels​

After creating a channel, you must validate the credentials. This ensures:

  1. All required credentials are provided
  2. The credentials grant proper access
  3. The provider's API can be reached successfully

The validation process will:

  1. Check all credentials format
  2. Attempt to connect to the provider's API
  3. Update the channel status to active if successful

If validation fails, the channel status remains pending_validation with error details.

Shipping Channel Statuses​

Shipping channels can have the following statuses:

StatusDescription
pending_validationNewly created, awaiting validation
activeValidated and working correctly
inactiveManually disabled by the user
errorFailed validation or encountered an error

Using Shipping Channels​

Once a shipping channel is validated and active, you can:

  1. Create shipments with one or more parcels
  2. Generate and download shipping labels
  3. Create tracking parcels linked to the channel
  4. Receive status updates automatically
  5. Query tracking information through the API

For details on creating shipments, see the Shipments Guide.

Maintaining Shipping Channels​

To ensure reliable service:

  1. Monitor channel status via API or dashboard
  2. Update credentials when they change or expire
  3. Configure webhook notifications for channel status changes

Security Considerations​

Shipping provider credentials are sensitive information. The API follows security best practices:

  • API credentials are encrypted at rest
  • Credential values are never exposed in API responses
  • Access to shipping channels is restricted to their owners

Troubleshooting​

Common issues with shipping channels include:

  1. Invalid Credentials: Double-check all credential values
  2. API Limits: Providers may enforce rate limits
  3. Permissions: Ensure credentials have proper permissions
  4. Network Issues: Check if provider API is accessible

When troubleshooting, utilize the validation endpoint to verify credentials and check the detailed error messages returned.