Make your first API call

This tutorial guides you step by step through authenticating with the Quivo API and making your first API call to verify your setup.

Prerequisites

Before you start, make sure you have:

API credential: A client ID (it starts with qak_) and a client secret. An Account Admin creates the credential in The Connector web app. See Create an API credential.

All API examples in this guide use ${BASE_URL} as a placeholder. Replace it with the correct base URL configured for the correct environment. For more information see Environments page.

Step 1: Obtain an access token

Exchange your client ID and client secret for an access token via the POST /v2/oauth2/token endpoint. Send them with HTTP Basic authentication: the client ID is the username and the client secret is the password.

Request
Response

Use this request to get an access token:

curl -X POST "${BASE_URL}/v2/oauth2/token" \
  -u "your-credential-id:your-secret" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials"

A successful request returns a 200 OK status code with the access token:

{
  "access_token": "<YOUR_ACCESS_TOKEN>",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "api"
}

Save the access_token value from the response. You’ll use it in the next step.

Step 2: Make your first authenticated API call

Include the access token in the Authorization header as a Bearer token. With an access token, all API paths start with /v2. The following example shows how to make an authenticated request using the GET /sellers endpoint to retrieve your seller information.

Request
Response

Use this request to retrieve your seller information:

curl -X GET "${BASE_URL}/v2/sellers" \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"

A successful authenticated request returns a 200 OK status code with your seller information:

{
  "sellerId": <YOUR_SELLER_ID>,
  "name": "<SELLER_NAME>",
  "status": "<STATUS>"
}

If authentication fails, you will receive a 401 Unauthorized error. In that case, check that:

Your client ID and client secret are correct, and the credential is not revoked or expired
You send the header as Authorization: Bearer <YOUR_ACCESS_TOKEN>
Your access token has not expired (tokens expire after 1 hour)

Verify your setup

If you get your seller information back, your setup works. You can now call the other endpoints.

Where to go next

Now that you have made your first API call, continue with these guides:

Send Inventory

Send your products to Quivo warehouses to make them available for fulfillment.

Create a Fulfillment Order

Programmatically submit fulfillment orders to trigger the pick and pack process.

Introduction

Quickstart

Quivo Flows

Webhooks

Make your first API call

Prerequisites

Step 1: Obtain an access token

Step 2: Make your first authenticated API call

Verify your setup

Where to go next

Send Inventory

Create a Fulfillment Order

​Prerequisites

​Step 1: Obtain an access token

​Step 2: Make your first authenticated API call

​Verify your setup

​Where to go next

Send Inventory

Create a Fulfillment Order

Prerequisites

Step 1: Obtain an access token

Step 2: Make your first authenticated API call

Verify your setup

Where to go next