Quickstart: Create a Document

Create your first product and warehouse document in under 10 minutes.

Step 1: Get an Access Token

First, obtain an access token. See the Authentication Guide for full details and alternative methods.

TOKEN=$(curl -s -X POST https://app.logistics-wms.com/api/external/v1/auth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET" \
  | jq -r '.access_token')

Step 2: Create a Product

Before creating a document with product lines, the products must exist in the system. Let's create a simple product.

curl -X POST https://app.logistics-wms.com/api/external/v1/product \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "externalCode": "ERP-SKU-001",
    "description": "Wireless Bluetooth Headphones",
    "barcode": "5901234123457",
    "weight": 0.35,
    "volume": 0.002,
    "observations": "Fragile - handle with care"
  }'

Response

{
  "externalCode": "ERP-SKU-001",
  "description": "Wireless Bluetooth Headphones",
  "barcode": "5901234123457",
  "weight": 0.35,
  "volume": 0.002,
  "observations": "Fragile - handle with care"
}

Step 3: Create a Purchase Order Document

Now let's create a purchase order (incoming goods from a supplier) with the product we just registered.

curl -X POST https://app.logistics-wms.com/api/external/v1/document \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "externalCode": "PO-2026-0001",
    "documentType": "PURCHASE_ORDER",
    "originCode": "SUPPLIER-ACME",
    "observations": "Expected delivery: 2026-04-20",
    "lines": [
      {
        "externalCode": "ERP-SKU-001",
        "quantity": 500,
        "lineNumber": 1
      }
    ]
  }'

Understanding the Request

Response

{
  "externalCode": "PO-2026-0001",
  "documentType": "PURCHASE_ORDER",
  "status": "OPEN",
  "originCode": "SUPPLIER-ACME",
  "observations": "Expected delivery: 2026-04-20",
  "lines": [
    {
      "externalCode": "ERP-SKU-001",
      "quantity": 500,
      "lineNumber": 1
    }
  ]
}

The document is now created with status OPEN. Warehouse operators will see it in the WMS and can begin processing the reception when the goods arrive.

Step 4: Verify the Document

Retrieve the document you just created to verify it was saved correctly.

curl -X GET https://app.logistics-wms.com/api/external/v1/document/PO-2026-0001 \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

{
  "externalCode": "PO-2026-0001",
  "documentType": "PURCHASE_ORDER",
  "status": "OPEN",
  "originCode": "SUPPLIER-ACME",
  "observations": "Expected delivery: 2026-04-20",
  "lines": [
    {
      "externalCode": "ERP-SKU-001",
      "quantity": 500,
      "lineNumber": 1
    }
  ]
}

Next Steps