Skip to Content

Developer / API Learning Center

Integrate shipping, tracking, labels, and rate quotes into your platform.

New Account Explore Our Services

Getting Started

This guide walks you through the fastest path to a working integration: generate API keys, send your first request, and (optionally) configure webhooks for real-time events.

Quick note: If you’re migrating from a legacy XML/EDI integration, you can still use those endpoints. For new builds, we recommend starting with API keys + webhooks for a cleaner integration.

1) Generate API keys

API keys are generated from your account portal in the API Access & Activity page. You can copy keys when needed and regenerate them if you’re rotating credentials.

API Access & Activity page showing API keys and recent activity

  • If you don’t have keys yet, click Request API Keys to generate them.
  • Once generated, you’ll see your Production key (and a Test key if available) listed on this page.
  • Store keys securely (password manager / secrets vault / environment variables).

2) Authentication

For SmartShip API endpoints, authentication is handled by passing your API key in the request URL as a query string parameter named key.

Keep your API key server-side whenever possible. Do not expose it in public-facing pages or client-side JavaScript.

Example

GET https://www.jetdelivery.com/api/v1/utilities/track/?idx=2345678&key=YOUR_API_KEY
Some endpoints work without a key, but including your key unlocks account-specific behavior:
  • Quotes: without a key you’ll see standard/list rates; with a key you’ll receive your negotiated account rates.
  • Tracking: without a key we may hide precise pickup/delivery details for privacy (for example, using the center of the ZIP code). With a key, authorized users can see more accurate shipment details.
Heads up: We monitor for unusual usage (for example, tracking multiple customers’ shipments from the same IP). If requests appear unauthorized, your access may be temporarily blocked for security. If that happens, contact us and we’ll help you get unblocked (often by approving your IP for testing).

3) Send your first request

Start with a quote request (fastest to validate authentication + connectivity), then move to shipment creation and tracking. 

curl "https://www.jetdelivery.com/api/v1/utilities/quote/?origin=90021&destination=92050&weight=50&key=YOUR_API_KEY"
Tip: Replace the endpoint + header format with the values shown in your API reference. If you want, we can standardize your auth header across all endpoints for consistency.

4) Set up webhooks (recommended)

Webhooks let Jet Delivery push shipment events to your system in real time (pickup, delivery, dispatch changes, etc.). This is the best way to keep your platform up to date without polling.

  • Create a webhook endpoint in your system (HTTPS recommended).
  • Configure the endpoint URL + events in your account portal.
  • Log deliveries and return a 200 response quickly; process asynchronously when possible.
Security: If you enable shared secrets or HMAC signatures, verify them on every webhook request.

Troubleshooting

  • 401/403: Key missing, invalid, or wrong header format.
  • 400: Request payload failed validation (missing required fields).
  • No webhook deliveries: Endpoint not reachable, non-200 responses, or events not selected.