---
updatedAt: 2026-04-23T13:29:19.000Z
agentTools:
projectIndex: https://developer.xentral.com/llms.txt
---
# Set total stock on storage locations
This endpoint sets the total stock for one or more storage locations.
The stock data provided in the payload, including quality control attributes (batch, best-before date, and serial number), will be taken over as the new stock for the specified storage location(s).
CAUTION: Any stock that was previously present in the storage location and is not specified in the payload will be removed from the storage location. This also includes the quality control attributes.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Xentral API",
"version": "v0.1",
"description": "Xentral is an ERP platform.",
"contact": {
"name": "Xentral",
"url": "https://xentral.com",
"email": "api@xentral.com"
}
},
"tags": [
{
"name": "Storage Location",
"description": "Represents the spaces within a warehouse"
}
],
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Bearer token obtained in POST /tokens endpoint or pregenerated in the system."
}
}
},
"security": [
{
"BearerAuth": []
}
],
"servers": [
{
"url": "https://{xentralId}.xentral.biz",
"description": "Your Xentral Instance",
"variables": {
"xentralId": {
"default": "xentral"
}
}
},
{
"url": "https://{domain}",
"description": "Xentral at a custom domain",
"variables": {
"domain": {
"default": "xentral.com"
}
}
}
],
"x-readme": {
"samples-languages": []
},
"paths": {
"/api/v1/storageLocations/setTotalStock": {
"patch": {
"tags": [
"Storage Location"
],
"operationId": "storageLocations.setTotalStock",
"summary": "Set total stock on storage locations",
"description": "This endpoint sets the total stock for one or more storage locations.
The stock data provided in the payload, including quality control attributes (batch, best-before date, and serial number), will be taken over as the new stock for the specified storage location(s).
CAUTION: Any stock that was previously present in the storage location and is not specified in the payload will be removed from the storage location. This also includes the quality control attributes.",
"requestBody": {
"description": "Overwrite stock for given products and storage Location",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"storageLocation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "\\d+",
"example": "17",
"description": "Resource identifier."
}
}
},
"totalStock": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "\\d+",
"example": "17",
"description": "Resource identifier."
}
}
},
"quantity": {
"type": "number"
},
"qualityControlAttributes": {
"type": "object",
"properties": {
"batch": {
"type": "string"
},
"bestBeforeDate": {
"type": "string"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"number"
],
"properties": {
"number": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"examples": {
"update total stock": {
"value": {
"data": [
{
"storageLocation": {
"id": "123"
},
"totalStock": [
{
"product": {
"id": "123"
},
"quantity": 5
}
]
}
]
}
},
"update total stock with quality control attributes": {
"value": {
"data": [
{
"storageLocation": {
"id": "123"
},
"totalStock": [
{
"product": {
"id": "234"
},
"quantity": 5,
"qualityControlAttributes": {
"batch": "L12345",
"bestBefore": "2030-12-31",
"serialNumbers": [
{
"number": "10001"
},
{
"number": "10002"
},
{
"number": "10003"
},
{
"number": "10004"
},
{
"number": "10005"
}
]
}
}
]
}
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "Operation completed successfully, no response body"
},
"400": {
"description": "IETF RFC 9457 Problem API compliant response",
"content": {
"application/problem+json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"violations"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/request-validation"
]
},
"title": {
"type": "string",
"minLength": 1,
"example": "Request payload validation failed."
},
"violations": {
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"example": {
"username": [
"This value should not be blank."
],
"email": [
"This value is not a valid email address."
]
}
},
"description": "This field will be a mirrored request payload with only invalid fields and values replaced by error messages."
},
{
"type": "object",
"example": {
"_": [
"This value should contain at most `9` elements."
]
},
"description": "This field will be a mirrored request payload with only invalid fields and values replaced by error messages."
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"messages"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/generic-validation"
]
},
"title": {
"type": "string",
"minLength": 1
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"messages"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/conflict"
]
},
"title": {
"type": "string",
"minLength": 1
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"items"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/conflictItems"
]
},
"title": {
"type": "string",
"minLength": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"title",
"messages"
],
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string",
"minLength": 1
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"scopes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://developer.xentral.com/reference/problems#token-scopes"
]
},
"title": {
"type": "string",
"minLength": 1
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"messages"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/generic-validation"
]
},
"title": {
"type": "string",
"minLength": 1
},
"messages": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
}
}
},
"401": {
"description": "Unable to authenticate the client",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error message explaining why the request failed.",
"example": "Missing required scopes: customer:create."
}
}
},
"example": {
"message": "Missing required scopes: customer:create."
}
},
"text/html": {
"schema": {
"type": "string",
"example": "Unauthorized"
}
}
}
},
"403": {
"description": "Unable to authorize the client"
},
"404": {
"description": "Resource was not found or not enough access privileges"
},
"415": {
"description": "Resource representation send in the request is not supported."
},
"429": {
"description": "Too many API calls made."
}
}
}
}
}
}
```