Getting started

Updated May 31, 20261 min read

This is the shortest path from a Carriyo account to a working API integration. Two steps, roughly 10 minutes.

Before you start

You need a Carriyo tenant. If you don't have one yet, create a free account. The free tier is enough to run through every step on this page.

You also need the Admin role in the Dashboard to retrieve credentials.

The two steps

Step 1

Get API credentials

Tenant ID, API key, merchant ID, and an OAuth client ID + secret.

Step 2

Make your first API call

Exchange credentials for an OAuth token. Create your first shipment with cURL.

Configure the Dashboard first?

The two steps above assume your Carriyo account already has at least one merchant, one shipping location, and one carrier account: the minimum data a shipment needs. If you don't have those yet, run through the operator-side onboarding first: Guides → Getting started.