Gateway API Reference

The Gateway API gives active customers programmatic access to their account — shipments, insurance, customs filings, tariff lookups, vessel schedules, documents, and webhooks. All endpoints are JSON over HTTPS.

Authentication

All requests require an API key sent via the Authorization header. Keys are scoped to a single Gateway account and inherit your account's permissions.

curl https://app.gatewaylines.com/api/v1/shipments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Returns standard HTTP status codes. 401 means missing or invalid key.403 means the key lacks permission for the resource.

API Keys

API keys are managed inside your Gateway customer portal. Sign in to app.gatewaylines.com, open the API Keys section under your profile, and create a key. You can rotate, pause, or revoke keys at any time.

• Keys never expire automatically — rotate on your own cadence.
• Each key has a per-month call counter visible in the portal.
• Treat keys like passwords — never commit them to source control.

View and create shipments from your Gateway account

View cargo insurance policies and claims on your shipments

View purchase orders and supplier shipments

Access your product catalog with SKUs, HTS codes, and origin data

Access your supplier directory

Manage carriers, brokers, forwarders, and other vendors

OTI Lookup, FMCSA Carrier, Customs Broker, SCAC, Corporation, and Denied Party Screening

Submit customs filings and run compliance checks

HTS code lookup, keyword search, and tariff exposure analysis

Calculate carbon emissions for ocean shipping routes

Search sailing schedules, port traffic, and vessel movements

Port congestion data and ML-powered rate forecasting

Shipping analytics, KPIs, spend breakdowns, and reports

Access your Gateway invoices and payment history

Access shipping documents (BOL, commercial invoices, packing lists)

Get domestic courier shipping rates (UPS, FedEx, USPS)

Look up port information by UN/LOCODE

Subscribe to real-time events. Gateway sends POST requests to your URL when events occur.

Check API and system health status