[beta] Create a stock movement

post

https://api.samsara.com/maintenance/parts/stock-movements

Records a receive, transfer, scrap, or adjust stock movement against a part's inventory and returns the resulting inventory location(s). Not idempotent — retrying a request that already succeeded records the movement again.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Parts under the Work Orders category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for the CreateStockMovement action

batch

string

Batch or lot identifier the movement applies to, if the part is batch-tracked.

fromPlaceId

string

Unique identifier of the place linked to the maintenance site the inventory is transferred out of. Transfer only.

happenedAtTime

string

Time when the movement occurred. Defaults to the current time if not provided.

movementType

string

required

Type of stock movement to record. Must be one of Receive, Transfer, Scrap, or Adjust; Unknown is rejected.

notes

string

Notes explaining the movement. Scrap and adjust only.

partSamsaraId

string

required

Unique identifier of the part definition the movement applies to.

placeId

string

Unique identifier of the place linked to the maintenance site the movement targets. Required for receive, scrap, and adjust; rejected for transfer (use fromPlaceId and toPlaceId).

purchaseOrder

string

Purchase order reference for the received inventory. Receive only.

quantity

double

required

Quantity moved, in the part's unit of measure. Positive magnitude for receive, transfer, and scrap; signed delta for adjust.

toPlaceId

string

Unique identifier of the place linked to the maintenance site the inventory is transferred into. Transfer only.

unitCost

object

EntityCreateStockMovementMoneyInput object

vendorId

string

Unique identifier of the vendor the inventory was received from. Receive only.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK response.

401Unauthorized response.

404Not Found response.

405Method Not Allowed response.

429Too Many Requests response.

500Internal Server Error response.

501Not Implemented response.

502Bad Gateway response.

503Service Unavailable response.

504Gateway Timeout response.

defaultBad Request response.