WMS · API Reference

Pulpo Hold API

Hold är stock-master: inventory, locations, movements och plocklistor. Produktmaster synkas från Core.

Bas-URL
http://localhost:3849
Auth
X-API-Key: <HOLD_API_KEY>
Notering
Alla endpoints utom health kräver API-nyckel.

Om Hold

Felformat

Error responsejson
{
  "ok": false,
  "error": "Unauthorized"
}

System

GET/api/healthPublik

Health check

Request

Ingen request body

Response

Service-info

Exampleapplication/json
{
  "ok": true,
  "service": "pulpo-hold",
  "product": "WMS"
}

Inventory

GET/api/inventoryAuth

Lista saldon

Parameters

NamnInTypBeskrivning
viewquerysummaryAggregerat per SKU
warehouseIdquerystringFiltrera warehouse

Request

Ingen request body

Response

Saldorader

Exampleapplication/json
{
  "ok": true,
  "inventory": [
    {
      "sku": "DEMO-1",
      "name": "Demo-produkt",
      "warehouseId": "wh_sto_01",
      "locationId": "loc_a0101",
      "onHand": 42,
      "reserved": 2,
      "available": 40
    }
  ]
}
POST/api/inventory/importAuth

Importera absolut saldo

Woo CSV / cutover. dryRun rekommenderas först.

Request

Bodyapplication/json
{
  "dryRun": true,
  "csv": "sku,stock\nDEMO-1,42\nDEMO-2,18"
}

Response

Importresultat

Exampleapplication/json
{
  "ok": true,
  "dryRun": true,
  "rows": 2,
  "applied": 0
}

Movements

POST/api/movementsAuth

Inleverans (receive)

Ökar onHand på angiven location.

Request

FältTypBeskrivning
type*"receive"Movement-typ
warehouseId*stringWarehouse-id
locationId*stringLocation-id
sku*stringSKU
qty*numberAntal
Bodyapplication/json
{
  "type": "receive",
  "warehouseId": "wh_sto_01",
  "locationId": "loc_a0101",
  "sku": "DEMO-1",
  "name": "Demo-produkt",
  "qty": 10,
  "note": "Testinleverans"
}

Response

Movement skapad

Exampleapplication/json
{
  "ok": true,
  "movement": {
    "id": "mov_…",
    "type": "receive",
    "sku": "DEMO-1",
    "qty": 10,
    "createdAt": "2026-09-12T11:00:00.000Z"
  }
}
POST/api/movementsAuth

Justering (adjust)

Positiv delta = öka, negativ = minska.

Request

Bodyapplication/json
{
  "type": "adjust",
  "warehouseId": "wh_sto_01",
  "locationId": "loc_a0101",
  "sku": "DEMO-1",
  "name": "Demo-produkt",
  "delta": -2,
  "note": "Inventering"
}

Response

Justering sparad

Exampleapplication/json
{
  "ok": true,
  "movement": {
    "id": "mov_…",
    "type": "adjust",
    "delta": -2
  }
}
POST/api/movementsAuth

Flytt (transfer)

Request

Bodyapplication/json
{
  "type": "transfer",
  "warehouseId": "wh_sto_01",
  "fromLocationId": "loc_a0101",
  "toLocationId": "loc_pick",
  "sku": "DEMO-1",
  "name": "Demo-produkt",
  "qty": 3
}

Response

Flytt sparad

Exampleapplication/json
{
  "ok": true,
  "movement": {
    "id": "mov_…",
    "type": "transfer",
    "qty": 3
  }
}

Plock

POST/api/picksAuth

Skapa plocklista

Från externt ordersystem (externalOrderId + warehouseId) eller manuellt med lines.

Request

Bodyapplication/json
{
  "warehouseId": "wh_sto_01",
  "externalOrderId": "order-id-from-oms-or-erp"
}

Response

Plocklista skapad

Exampleapplication/json
{
  "ok": true,
  "pick": {
    "id": "pick_…",
    "status": "picking",
    "warehouseId": "wh_sto_01",
    "externalOrderId": "order-id-from-oms-or-erp",
    "lines": [
      {
        "sku": "DEMO-1",
        "qty": 1
      }
    ]
  }
}
PATCH/api/picks/:idAuth

Uppdatera plockstatus

Status picked/shipped drar saldo via pick-lagerhändelse.

Parameters

NamnInTypBeskrivning
id*pathstringPlocklista-id

Request

Bodyapplication/json
{
  "status": "picked"
}

Response

Uppdaterad

Exampleapplication/json
{
  "ok": true,
  "pick": {
    "id": "pick_…",
    "status": "picked"
  }
}

Produkter

POST/api/products/importAuth

Synka produkter från Core

Parameters

NamnInTypBeskrivning
fromquerycorePull + upsert från Core

Request

Ingen request body

Response

Upsert klar

Exampleapplication/json
{
  "ok": true,
  "imported": 24,
  "source": "core"
}

Att tänka på

  • Produktmaster = Core · Hold håller operativ kopia
  • Movement types: receive, transfer, adjust, pick
  • Plockstatus: picking | picked | shipped | cancelled