API Reference

Apply stock actions to items (bulk)

patch
https://stock.ordermentum.com/v1/items

Applies one or more stock actions. action is one of ADD, REMOVE, UPDATE or CLEAR. Stock is applied at the supplied locationId, defaulting to the item's defaultLocationId. The request body is capped at 1 MB; keep batches to roughly 50–100 actions per call.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Note: name and productId on each action are required (enforced downstream) even though some older docs show them as optional. name is free-text and used only internally.

actions
array of objects
required
length ≥ 1
actions*
uuid
required

The Variant ID of the product or variant

string
enum
required
Allowed:
string
required
uuid
required
number
Defaults to 0
uuid | null

Defaults to the item's defaultLocationId.

Headers
string
enum
required

Context entity type. Required on all stock-service endpoints.

Allowed:
uuid
required

Supplier (or retailer) id for the context. Required on all stock-service endpoints.

Responses

Updated 24 minutes ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 minutes ago