Docs API ReferenceInventory

Inventory API

Track and manage inventory levels across warehouses

Endpoints

Available inventory management endpoints

GET/inventoryList inventory levels

GET/inventory/{sku}Get inventory for a specific SKU

PUT/inventory/{sku}Update inventory levels

POST/inventory/bulkBulk update inventory

POST/inventory/adjustAdjust inventory (increment/decrement)

GET/inventory/low-stockGet low stock alerts

The Inventory Object

Field	Type	Description
sku	string	Stock keeping unit identifier
productId	string	Associated product ID
productName	string	Product display name
quantity	integer	Total physical quantity in stock
reservedQuantity	integer	Quantity reserved for pending orders
availableQuantity	integer	Quantity available for new orders (quantity - reserved)
reorderPoint	integer	Threshold that triggers low-stock alert
reorderQuantity	integer	Suggested quantity to reorder
warehouseId	string	Warehouse location identifier
warehouseName	string	Warehouse display name
lastUpdated	string	ISO 8601 timestamp of last update

List Inventory

GET/inventory

Retrieve inventory levels for all products. Supports filtering by warehouse, low-stock status, and SKU prefix.

Query Parameters

warehouse_id	string	Filter by warehouse
low_stock	boolean	Only return items below reorder point
sku_prefix	string	Filter by SKU prefix
page	integer	Page number (default: 1)
per_page	integer	Items per page (max: 100)

curl -X GET "https://gateway.regentherapy.com/api/v1/inventory" \
  -H "X-API-Key: rg_your_api_key" \
  -H "Content-Type: application/json"

Update Inventory

PUT/inventory/{sku}

Set the absolute quantity for a specific SKU. Use this for inventory syncs or corrections.

Important

This endpoint sets the absolute quantity. For incremental adjustments, use the /inventory/adjust endpoint instead.

curl -X PUT "https://gateway.regentherapy.com/api/v1/inventory/REGEN-001" \
  -H "X-API-Key: rg_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "quantity": 200,
    "reorderPoint": 30,
    "reorderQuantity": 100,
    "reason": "Stock replenishment from supplier"
  }'

Adjust Inventory

POST/inventory/adjust

Increment or decrement inventory by a specified amount. Use positive values to add stock, negative to remove.

curl -X POST "https://gateway.regentherapy.com/api/v1/inventory/adjust" \
  -H "X-API-Key: rg_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "REGEN-001",
    "adjustment": -5,
    "reason": "Damaged units removed",
    "referenceId": "DMG-2024-001"
  }'

Bulk Update

POST/inventory/bulk

Update multiple inventory records in a single request. Supports up to 100 SKUs per request.

curl -X POST "https://gateway.regentherapy.com/api/v1/inventory/bulk" \
  -H "X-API-Key: rg_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "updates": [
      { "sku": "REGEN-001", "quantity": 200 },
      { "sku": "REGEN-002", "quantity": 150 },
      { "sku": "REGEN-003", "quantity": 75 }
    ],
    "reason": "Inventory sync from ERP"
  }'

Best Practices

Always include a reason field for audit trail purposes.

Use /inventory/adjust for day-to-day operations to maintain accurate history.

Subscribe to inventory.low_stock webhooks for proactive reordering.

Use bulk updates for ERP syncs to reduce API calls and improve performance.

Products API Commissions API