Carriyo Inventory API

Download OpenAPI specification

The Carriyo Inventory API enables you to manage stock levels across your fulfillment locations and track inventory changes over time.

Key Resources

• Inventory - View and manage stock levels by product and location
• Inventory Events - Submit and track inventory changes

Overview

The Inventory API provides a comprehensive solution for:

• Stock Level Management : Track on-hand, reserved, and unavailable quantities
• Multi-Location Support : Manage inventory across warehouses, stores, and fulfillment centers
• Event-Based Updates : Submit inventory changes through events for audit trails
• Order Integration : Automatic inventory reservation when orders are allocated

How Inventory Works

Stock Quantities

For each product at each location, Carriyo tracks:

• On Hand : Total physical quantity available
• Reserved : Quantity allocated to orders but not yet shipped
• Unavailable : Quantity not available for sale (damaged, expired, etc.)

Available Quantity = On Hand - Reserved - Unavailable

Event-Based Updates

Instead of directly setting inventory values, you submit Inventory Events that describe changes:

• SET events replace current values
• ADJUST events add or subtract from current values

This approach provides a complete audit trail of all inventory changes.