WMS Biz Developer API Reference

Welcome to the WMS Biz Developer API. This guide provides the documentation needed to integrate your external storefronts, mobile applications, and internal tools with the WMS Biz backend.

Base URL

All API requests should be made to the following base URL:

https://api.wmsbiz.cloud/v1

(For local development, use http://localhost:4000/api)

---

Authentication

Authentication is handled via JSON Web Tokens (JWT). You must include your JWT in the Authorization header of every request.

Authorization: Bearer <YOUR_JWT_TOKEN>

Get Current User Profile

Retrieves the profile and permissions of the currently authenticated user.

Endpoint: GET /auth/me

Response (200 OK):

{
  "user": {
    "id": "usr_12345",
    "email": "admin@company.com",
    "role": "ADMIN",
    "companies": [
      {
        "id": "comp_12345",
        "name": "Acme Corp",
        "onboarding_completed": true
      }
    ]
  }
}

---

Products (Inventory)

List Products

Retrieve a list of all active products (SKUs) in your catalog.

Endpoint: GET /inventory/products

Response (200 OK):

{
  "products": [
    {
      "id": "prod_88219",
      "sku": "LAPTOP-PRO-15",
      "name": "15-inch Pro Laptop",
      "base_price": 1299.99,
      "cost_price": 850.00,
      "brand": { "name": "TechBrand" },
      "category": { "name": "Electronics" }
    }
  ]
}

Get Stock Levels

Retrieve the current aggregated stock levels for a specific product.

Endpoint: GET /inventory/stock/:productId

Response (200 OK):

{
  "productId": "prod_88219",
  "quantity_on_hand": 142,
  "allocated": 12,
  "available": 130
}

---

Sales & Fulfillment

Create Sales Order

Programmatically create a new Sales Order (e.g., from an external Shopify or WooCommerce storefront).

Endpoint: POST /sales/orders

Request Body:

{
  "customerId": "cust_99812",
  "items": [
    {
      "productId": "prod_88219",
      "quantity": 2,
      "unitPrice": 1299.99
    }
  ],
  "shippingMethod": "DPD Next Day",
  "notes": "External web order #10042"
}

Response (201 Created):

{
  "success": true,
  "orderId": "so_55412",
  "status": "PENDING",
  "total": 2599.98
}

Fetch Order Status

Check the fulfillment status of an existing order.

Endpoint: GET /sales/orders/:orderId

Response (200 OK):

{
  "orderId": "so_55412",
  "status": "SHIPPED",
  "tracking_number": "DPD881293812GB",
  "shipped_at": "2026-05-27T14:30:00Z"
}

---

Error Handling

WMS Biz uses standard HTTP status codes to indicate the success or failure of an API request.

• 200 OK: Request succeeded.
• 201 Created: Resource successfully created.
• 400 Bad Request: The request was invalid (e.g., missing required fields).
• 401 Unauthorized: Authentication failed (missing or invalid token).
• 403 Forbidden: Authenticated, but lacking the required RBAC permissions.
• 404 Not Found: The requested resource does not exist.
• 500 Internal Server Error: Something went wrong on our end.

All errors return a standard JSON payload:

{
  "error": "Human readable error description."
}