Back to Help Center
Developer Guide

API
Documentation

Integrate Oryn with your existing systems using our powerful REST API.

Oryn dashboard preview for API integrations

Build Custom Integrations

Oryn's REST API gives developers full programmatic access to inventory data. Whether you're syncing with an e-commerce platform, connecting to your ERP system, or building custom workflows, our API provides the flexibility you need.

All endpoints return JSON responses and follow RESTful conventions. Our API is available on Core and Pro plans, with rate limits based on your subscription tier.

API Capabilities

Inventory Management

Create, read, update, and delete inventory items. Manage quantities, locations, and custom fields programmatically.

Movement Tracking

Record stock movements, transfers, and adjustments. Query movement history for audit trails.

Location Management

Manage warehouses, zones, racks, and bins. Update location hierarchies and assignments.

Webhooks

Receive real-time notifications when inventory changes. Configure custom webhook endpoints.

Getting Started

1. Generate API Key

Navigate to Settings → API in your Oryn dashboard. Click "Generate New Key" and store it securely. Keys can be scoped to specific permissions.

2. Authenticate Requests

Include your API key in the Authorization header of every request: Authorization: Bearer YOUR_API_KEY

3. Make Your First Call

Start with a simple GET request to /api/v1/items to retrieve your inventory list. All responses are in JSON format.

4. Explore Endpoints

Check our interactive API explorer for all available endpoints, request parameters, and response schemas.

Core Endpoints

GET

/api/v1/items

Retrieve all inventory items with pagination. Supports filtering by category, location, status, and custom fields.

POST

/api/v1/items

Create a new inventory item. Include name, SKU, quantity, location, and any custom field values.

PUT

/api/v1/items/{id}

Update an existing item. Partial updates supported—only include fields you want to change.

POST

/api/v1/movements

Record a stock movement. Specify type (in/out/transfer), quantity, source, destination, and reason.

Common Integrations

E-commerce Sync

Automatically update Oryn inventory when orders come in from Shopify, WooCommerce, or your custom store.

ERP Integration

Connect with SAP, NetSuite, or QuickBooks to keep financial and inventory data in sync.

Automation Tools

Use Zapier, Make, or custom scripts to automate routine inventory tasks and workflows.

BI & Reporting

Pull inventory data into Tableau, Power BI, or custom dashboards for advanced analytics.

Rate Limits & Support

Rate Limits

Core plan: 1,000 requests/hour. Pro plan: 10,000 requests/hour. Enterprise: Unlimited with dedicated support.

Developer Support

Pro and Enterprise customers get priority developer support with dedicated integration assistance.

Ready to integrate?

Generate your API key and start building custom integrations today.