ScrymeDeveloper Docs
Inventory & Stocking V3 Module

Stocking & Inventory Endpoints

Comprehensive REST API endpoints for managing multi-branch stock transfers, supplier purchase order check-in, physical cycle counts, and proof-of-delivery logistics.


GET/v3/:orgSlug/stocking/transfers
List Stock Transfers

Retrieves paginated stock transfer records filtered by source location, destination, and status (DRAFT, SHIPPED, RECEIVED).

POST/v3/:orgSlug/stocking/transfers
Create Stock Transfer

Initiates a new inter-location transfer request between authorized inventory locations with line item variant allocations.

POST/v3/:orgSlug/stocking/transfers/:id/ship
Ship Stock Transfer

Deducts stock from origin location, locks items in transit status, and generates packing slip.

POST/v3/:orgSlug/stocking/transfers/:id/receive
Receive Stock Transfer

Confirms receipt of in-transit goods at destination location, allocating stock batches to target inventory.

GET/v3/:orgSlug/stocking/purchases
List Purchase Orders

Retrieves vendor purchase orders across organization branches with item line pricing and delivery status.

POST/v3/:orgSlug/stocking/purchases/:id/receive
Receive Purchase Order Items

Receives supplier delivery items into active inventory, creating new StockBatch records and setting expiry tags.

GET/v3/:orgSlug/stocking/physical-reconciliations
List Physical Reconciliations

Fetches scheduled and completed stocktaking audit sessions with variance summaries.

POST/v3/:orgSlug/stocking/physical-reconciliations
Submit Physical Reconciliation

Submits blind physical shelf counts, calculates shrinkage or surplus, and posts balancing ledger adjustments.

GET/v3/:orgSlug/stocking/physical-reconciliations/:id/report
Download Reconciliation PDF Report

Streams an immutable PDF audit document detailing counted variants, expected vs actual counts, and financial loss.

POST/v3/:orgSlug/stocking/reconciliation/dispatch
Dispatch Delivery Orders

Assigns drivers and vehicles to orders pending fulfillment, emitting delivery tracking updates.