Skip to main content
This reference provides an overview of the API structure and navigation. Welcome to the Quivo API Developer Portal. The REST (Representational State Transfer) API provides seamless integration with the logistics and fulfillment platform. This documentation is structured to support your integration journey, from initial setup to detailed implementation. For step-by-step guides, see our Tutorial and How-To sections.

​
Your Path to Integration

Follow these steps for a smooth integration experience:
  1. Start with Authentication to understand how to authenticate your requests. This is the essential first step before making any API calls.
  2. Follow the Quickstart Guides to learn the main workflows for managing inventory, orders, and shipments.
  3. Explore the API Reference to find the specific endpoints you need for your app.

Get Started

Start here if you are new. This section covers the essential first steps for a successful integration, including the authentication process and how to obtain session tokens.

API Reference

Go into the technical details. Explore all available endpoints, detailing required parameters, request and response examples, and error codes. Use this when you are ready to build.

​
Quickstart Guides

The following guides walk you through the main workflows for integrating with Quivo:

Send Inventory

Notify the Quivo warehouse that you are sending a shipment of products. Learn how to create inbound records and manage inventory shipments.

Create a Fulfillment Order

Programmatically submit fulfillment orders to the Quivo Connector. Trigger the pick and pack process for your products.

Track an Order

Retrieve current status and tracking information for orders. Monitor shipment progress and delivery status.

Manage Returns

Generate return labels and track returned items. Learn how to process customer returns through the API.

Manage Webhooks

Configure event subscriptions for real-time notifications. Set up webhooks to receive updates about order status changes and other events.

​
Authentication

All API requests require authentication using:
  1. Static API Key: Obtained through the Quivo Dashboard. Include it in the X-Api-Key header.
  2. Session Token: Obtained through the POST /login endpoint, valid for one hour. Include it in the Authorization header.
See the Authentication guide for detailed instructions on obtaining and using session tokens.