API Help & Guides

Create a Gateway Account

Sign up for a Gateway account at www.gatewaylines.com/sign-up. Once registered, you'll have access to the customer portal where you can manage API keys.

Generate an API Key

Navigate to Settings → API Keys in your dashboard. Click "Create New Key" and give it a descriptive name. Choose between two modes:

Make Your First Request

Test your API key by making a simple request to the shipments endpoint:

curl -X GET "https://www.gatewaylines.com/api/v1/shipments" \
  -H "Authorization: Bearer gw_test_your_key_here"

With a sandbox key, you'll receive mock test data:

{
  "success": true,
  "data": [...mock shipments...],
  "api_usage": {
    "calls_remaining": "unlimited",
    "mode": "sandbox"
  },
  "_sandbox": true,
  "_notice": "This is sandbox/test data..."
}

Once ready for production, switch to a production key (gw_...) to access real data.

Explore the API Reference

Now that you're connected, explore the full API reference to discover all available endpoints including shipment management, tracking, invoices, and EDI integration.