Track an Order

This guide shows you how to programmatically check if Quivo shipped an order and retrieve the carrier’s tracking link to share with your customer.

Prerequisites

Before you start, make sure you have:

Session token: A valid session token. See the Authentication guide to learn how to obtain one.
Order ID: The unique integer orderId returned when you created the order. Use the GET /orders endpoint to find it.

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.

Retrieve order details

To track an order, retrieve its full details using its unique ID via the GET /orders/{orderId} endpoint. A successful request returns a 200 OK status. The response body contains the order’s current state. Focus on two specific sections: the status and the tracking information. Timestamps use the ISO 8601 pattern YYYY-MM-DDTHH:mm:ssZ in Coordinated Universal Time UTC.

Request
Response

Use this request to retrieve the current status and tracking information for a specific order:

curl -X GET "${BASE_URL}/orders/<YOUR_ORDER_ID>" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>"

A successful request returns a 200 OK status code.

{
  "orderId": <YOUR_ORDER_ID>,
  "orderIdentifier": "<YOUR_ORDER_IDENTIFIER>",
  "orderReference": "<YOUR_ORDER_REFERENCE>",
  "orderStatus": "<ORDER_STATUS>",
  "orderDate": "<YYYY-MM-DDTHH:mm:ssZ>",
  "completedAt": "<YYYY-MM-DDTHH:mm:ssZ>",
  "shippingMethodName": "<SHIPPING_METHOD_NAME>",
  "shipmentTracking": [
    {
      "number": "<TRACKING_NUMBER>",
      "link": "<TRACKING_LINK>"
    }
  ],
  "positions": [
    {
      "sku": "<YOUR_SKU>",
      "name": "<PRODUCT_NAME>",
      "quantity": <QUANTITY>
    }
  ]
}

Locate the orderStatus field in the response body. This field indicates where the order is in the fulfillment lifecycle.

Status	Description
`PENDING`	The order has been received; however, we cannot start processing it due to missing information.
`PROCESSING`	The warehouse is currently picking and packing the items.
`COMPLETED`	The warehouse packed the order and handed it over to the carrier.
`CANCELLED`	The order is cancelled before fulfillment.

Once the status changes to COMPLETED, the system generates tracking information. Find this in the shipmentTracking array.

number: The tracking number assigned by the carrier.
link: A direct URL to the carrier’s tracking page.

Where to go next

Now that you can track orders, you can continue with these guides:

Manage Returns

Generate return labels and track returned items when customers need to send products back.

Manage Webhooks

Automate order tracking by setting up webhooks to receive real-time status updates.

Introduction

Quickstart

Quivo Flows

Webhooks

Prerequisites

Retrieve order details

Where to go next

Manage Returns

Manage Webhooks

Introduction

Quickstart

Quivo Flows

Webhooks

​Prerequisites

​Retrieve order details

​Where to go next

Manage Returns

Manage Webhooks

Prerequisites

Retrieve order details

Where to go next