StockActivity
Type: schema
Description
Something done to an item's stock in the change an inventory.updated reports.
TypeScript Definition
typescript
StockActivity: {{
/**
* @description What was done: `add`, `reduce`, `reserve`, `release`, `restore`, `reset`, `stock-in`, `stock-out`, or `sync` (a marketplace seller's stock synced in).
* @example reserve
*/
activity_type: string | null;
/** @description The warehouse it was done in; `null` when not warehouse-specific. */
warehouse_id: string | null;
/** @description Why, e.g. `order created`, `invoice cancelled`; `null` when none was given. */
reason: string | null;
};
/** StoreConfig */
}OpenAPI Schema
json
{
"title": "StockActivity",
"description": "Something done to an item's stock in the change an `inventory.updated` reports.",
"type": "object",
"externalDocs": {
"url": "https://llm-docs.commercengine.io/storefront/schemas/StockActivity",
"description": "API reference for the StockActivity schema"
},
"required": [
"activity_type",
"warehouse_id",
"reason"
],
"properties": {
"activity_type": {
"description": "What was done: `add`, `reduce`, `reserve`, `release`, `restore`, `reset`, `stock-in`, `stock-out`, or `sync` (a marketplace seller's stock synced in).",
"type": [
"string",
"null"
],
"examples": [
"reserve"
]
},
"warehouse_id": {
"description": "The warehouse it was done in; `null` when not warehouse-specific.",
"type": [
"string",
"null"
]
},
"reason": {
"description": "Why, e.g. `order created`, `invoice cancelled`; `null` when none was given.",
"type": [
"string",
"null"
]
}
}
}Auto-generated from OpenAPI spec and TypeScript definitions