HomeDocumentationAPIEndpoints
All Documentation

Endpoints

API endpoint reference

2 min read

API Endpoints

Complete reference for SmartWMS API endpoints.

Products

List Products
GET /api/v1/products

Query parameters:

  • page - Page number
  • pageSize - Items per page
  • search - Search term
  • category - Category filter
  • status - Active/Inactive
Get Product
GET /api/v1/products/{id}

Create Product
POST /api/v1/products
{
  "sku": "PROD-001",
  "name": "Widget",
  "barcode": "1234567890123",
  "category": "Widgets",
  "unit": "pcs"
}
Update Product
PUT /api/v1/products/{id}
{
  "name": "Updated Widget",
  "price": 29.99
}
Delete Product
DELETE /api/v1/products/{id}

Inventory

Get Stock Levels
GET /api/v1/inventory/stock

Query parameters:

  • productId - Filter by product
  • locationId - Filter by location
  • warehouseId - Filter by warehouse
Adjust Inventory
POST /api/v1/inventory/adjustments
{
  "productId": "uuid",
  "locationId": "uuid",
  "quantity": 10,
  "reason": "cycle_count",
  "notes": "Physical count adjustment"
}

Transfer Inventory
POST /api/v1/inventory/transfers
{
  "productId": "uuid",
  "fromLocationId": "uuid",
  "toLocationId": "uuid",
  "quantity": 5
}

Orders

List Orders
GET /api/v1/orders
Create Sales Order
POST /api/v1/orders/sales
{
  "customerId": "uuid",
  "lines": [
    {
      "productId": "uuid",
      "quantity": 2,
      "price": 19.99
    }
  ],
  "shippingAddress": {
    "street": "123 Main St",
    "city": "New York",
    "zip": "10001"
  }
}
Update Order Status
PATCH /api/v1/orders/{id}/status
{
  "status": "shipped",
  "trackingNumber": "1Z999AA10123456784"
}

Locations

List Locations
GET /api/v1/locations
Get Location Inventory
GET /api/v1/locations/{id}/inventory

Webhooks

List Webhooks
GET /api/v1/webhooks
Create Webhook
POST /api/v1/webhooks
{
  "url": "https://your-server.com/webhook",
  "events": ["order.created", "order.shipped"]
}

See Webhooks for event details.

Need help?

Can't find what you're looking for? Our support team is here to help.

Contact Support →