Stock history of a variant, newest first

GET

/api/v1/workspaces/{workspaceId}/inventory-items/{inventoryItemId}/movements

const url = 'https://api.crossmart.io/api/v1/workspaces/example/inventory-items/example/movements?reason=OPENING_BALANCE&direction=desc&limit=25';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.crossmart.io/api/v1/workspaces/example/inventory-items/example/movements?reason=OPENING_BALANCE&direction=desc&limit=25'

Parameters

Path Parameters

workspaceId

required

string

inventoryItemId

required

string

Query Parameters

reason

One of RECEIVED, CORRECTION, RETURNED, DAMAGED, LOST, SOLD. The other reasons are recorded by Crossmart.

string

Allowed values: OPENING_BALANCE ADJUSTMENT CORRECTION RECEIVED RETURNED DAMAGED LOST SOLD IMPORTED ORDER_SHIPPED

direction

string

Allowed values: asc desc

cursor

string format: uuid

nextCursor from the previous page

page

number

>= 1

1-based page number, for tables with page numbers. It wins over cursor.

limit

number

default: 25 >= 1 <= 100

Responses

200

application/json

object

items

required

Array<object>

object

required

string format: uuid

delta

required

Units added (positive) or removed (negative)

number

reason

required

string

Allowed values: OPENING_BALANCE ADJUSTMENT CORRECTION RECEIVED RETURNED DAMAGED LOST SOLD IMPORTED ORDER_SHIPPED

quantityAfter

required

Stock on hand right after this movement

number

note

required

string

nullable

userName

required

The user who made the change; null for API keys and changes made by Crossmart

string

nullable

apiKeyName

required

The API key that made the change, if any

string

nullable

createdAt

required

string format: date-time

nextCursor

required

Null on the last page

string

nullable

total

required

How many match in all, for page numbers

number

Example

{
  "items": [
    {
      "reason": "OPENING_BALANCE"
    }
  ]
}