QuickstartAuthenticationErrors

Quickstart

Get up and running with the ShipGenius API in just a few minutes.

1. Get Your API Key

First, generate your API key from the Apps page in your ShipGenius account.

  • Each API key is scoped to the specific app it belongs to.
  • You can regenerate or revoke keys at any time.

WARNING

Keep your API key secure — treat it like a password.

2. Authenticate Your Requests

Include your API key in the Authorization header using the Bearer token format.

3. Choose the Environment

Use one of the following GraphQL endpoints depending on your integration phase:

  • Sandbox:
    https://api.sandbox.lite.shipgeni.us/graphql

  • Production:
    https://api.lite.shipgeni.us/graphql

NOTE

Start in Sandbox while testing — it simulates real carrier behavior without generating real labels.

4. Test the Connection

Send the ping query to verify your credentials and check server health.

query {
    ping {
        name
        ip_address
        permissions
        current_datetime
    }
}

You're Ready!

You’re now authenticated and connected. From here, you can:

  • Shop for rates
  • Generate labels
  • Track packages
  • Automate fulfillment

Read through our OMS / WMS / eCommerce Platform Integration Guide before starting.

Next

Authentication →