Open Inventory / Docs
EndpointsStockResourcesIdStockMovements

Book a bulk stock change or structured location transfer

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

POST
/resources/{id}/stock/movements

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

id*string
Formatuuid

Header Parameters

Idempotency-Key?string

UUID identifying one queue operation; safe to reuse for retries.

Formatuuid
X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

application/json
  1. body
delta*integer

Positive receipts and negative issues. Structured transfers require zero because the global balance does not change.

Range-2000000000 <= value <= 2000000000
quantity?integer

Required and positive for a structured transfer; otherwise it must equal the absolute delta when provided.

Range0 <= value <= 2000000000
type*string
Value in"receipt""issue""adjustment""return""waste""transfer"
reason?|
Lengthlength <= 240
note?string
Lengthlength <= 20000
location?|
Lengthlength <= 240
fromLocationResourceId?|

Structured source location for an issue or transfer.

Formatuuid
toLocationResourceId?|

Structured destination location for a receipt or transfer.

Formatuuid
contactId?|

Active customer or supplier associated with this movement.

Formatuuid
occurredAt?string
Formatdate-time
totalPriceCents?|

Signed transaction value; negative values can represent outbound revenue. Inbound prices must be nonnegative.

Range-2000000000 <= value <= 2000000000
priceCurrency?|
Length3 <= length <= 3

Response Body

Replayed the original stock movement response

Example Request
curl -X POST 'https://inventory.example.com/api/v1/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/stock/movements' \  -H 'Content-Type: application/json' \  -d '{  "delta": -2000000000,  "type": "receipt"}'
Example Response
Empty