VUZDevelopers

Get stock movements

GET
/inventory/movements

Get stock movements with filtering and pagination

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

warehouseId?string

Filter by warehouse ID

productId?string

Filter by product ID

movementType?string

Filter by movement type

Value in

  • "purchase"
  • "sale_return"
  • "production_in"
  • "transfer_in"
  • "adjustment_in"
  • "count_adjustment_in"
  • "opening_balance"
  • "sale"
  • "purchase_return"
  • "production_out"
  • "transfer_out"
  • "adjustment_out"
  • "count_adjustment_out"
  • "damage"
  • "expiry"
  • "theft"
  • "sample"
  • "self_use"
documentId?string

Filter by document ID

adjustmentReason?string

Filter by adjustment reason

Value in

  • "damage"
  • "theft"
  • "expiry"
  • "self_use"
  • "found"
  • "count_variance"
  • "data_correction"
  • "write_down"
  • "donation"
  • "recall"
  • "qc_rejection"
  • "other"
fromDate?string

Start date (from)

Formatdate-time
toDate?string

End date (to)

Formatdate-time
search?string

Search by reference number or notes

page?number

Page number

Default1
limit?number

Items per page

Default50

Header Parameters

x-business-id*string

Business ID

Response Body

application/json

curl -X GET "https://example.com/inventory/movements" \  -H "x-business-id: string"
{  "items": [    {      "id": "string",      "sequentialNumber": 0,      "movementType": "purchase",      "quantity": 0,      "unit": "string",      "unitCost": 0,      "totalCost": 0,      "balanceBefore": 0,      "balanceAfter": 0,      "warehouseId": "string",      "warehouseName": "string",      "productId": "string",      "productName": "string",      "productSku": "string",      "referenceNumber": "string",      "referenceDocumentType": "string",      "documentId": "string",      "linkedMovementId": "string",      "notes": "string",      "reason": "string",      "adjustmentReason": "damage",      "createdBy": "string",      "createdByName": "string",      "createdAt": "2019-08-24T14:15:22Z",      "originType": "manual",      "originMeta": {},      "batchReference": "string",      "scannedImageUrl": "string"    }  ],  "total": 0}