Skip to main content
API Reference

Inventory API

Manage inventory levels, stock movements, and product information across your warehouses.

Endpoints

GET/inventoryList all inventory items
GET/inventory/{sku}Get inventory by SKU
POST/inventory/adjustAdjust inventory quantity
POST/inventory/transferTransfer between locations
GET/inventory/movementsGet movement history

Get Inventory by SKU

Retrieve current inventory levels for a specific SKU.

Request
GET /wms/v1/inventory/WIDGET-001
Authorization: Bearer YOUR_API_KEY
Response
{
  "sku": "WIDGET-001",
  "name": "Premium Widget",
  "total_quantity": 500,
  "available_quantity": 485,
  "reserved_quantity": 15,
  "locations": [
    {
      "warehouse_id": "WH-001",
      "location": "A-01-01",
      "quantity": 300
    },
    {
      "warehouse_id": "WH-001",
      "location": "A-01-02",
      "quantity": 200
    }
  ],
  "lot_numbers": ["LOT-2024-001", "LOT-2024-002"],
  "last_updated": "2024-12-04T10:30:00Z"
}

Adjust Inventory

Increase or decrease inventory with a reason code.

Request
POST /wms/v1/inventory/adjust
Content-Type: application/json

{
  "sku": "WIDGET-001",
  "warehouse_id": "WH-001",
  "location": "A-01-01",
  "adjustment": -5,
  "reason_code": "DAMAGED",
  "notes": "Damaged during handling"
}

Next Steps