Adjust variant stock by delta
Adjusts the stock quantity for a variant in a specific warehouse by adding or subtracting the provided delta value
/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/stock/{warehouse_slug}/diff- API
- Management
- OpenAPI
- management-api
- Updated
- Apr 26, 2026
management-api:POST:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/stock/{warehouse_slug}/diff
Adjusts the stock quantity for a variant in a specific warehouse by adding or subtracting the provided delta value
API ownership
- API family: Management API
- Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
- Do not use from: Browser-only storefront code or public clients.
- Guide route: /apis/management/latest
The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.
Operation
- Method:
POST - Path:
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/stock/\{warehouse_slug\}/diff - Summary: Adjust variant stock by delta
- Description: Adjusts the stock quantity for a variant in a specific warehouse by adding or subtracting the provided delta value
- OpenAPI contract: management-api
- Operation ID: Not documented in the OpenAPI contract.
Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| product_id | path | Yes | string | Product ID |
| variant_id | path | Yes | string | Variant ID |
| warehouse_slug | path | Yes | string | Warehouse slug |
| app_slug | path | Yes | string | App slug |
| team_slug | path | Yes | string | Team slug |
Request body
- Required: Yes
- Description: Variant stock diff data
- Content: application/json (object)
Variant Stock Diff
| Property | Type | Required | Details |
|---|---|---|---|
delta | integer | No | - |
Generated example (synthetic):
{
"delta": 0
}Responses
| Status | Description | Content |
|---|---|---|
| 200 | Warehouse stock for variant updated successfully | application/json (object) |
| 400 | Invalid request (e.g. bad UUID, validation error or stock can't be negative) | application/json (object) |
| 401 | Unauthorized access | application/json (object) |
| 500 | Internal server error | application/json (object) |
200 - object
Variant Warehouse Stock Response
| Property | Type | Required | Details |
|---|---|---|---|
data | object | No | - |
details | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes |
success | boolean | No | - |
Warehouse Variant Stock
| Property | Type | Required | Details |
|---|---|---|---|
available_online | boolean | No | - |
created_at | string | No | - |
id | string | No | - |
inventory_date | string | No | - |
quantity | integer | No | - |
updated_at | string | No | - |
warehouse_name | string | No | - |
warehouse_slug | string | No | - |
Generated example (synthetic):
{
"data": {
"available_online": false,
"created_at": "string",
"id": "string",
"inventory_date": "string",
"quantity": 0,
"updated_at": "string",
"warehouse_name": "string",
"warehouse_slug": "string"
},
"details": [
"string"
],
"success": false
}400 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}401 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}500 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}Contract identity
Use these fields to confirm you are implementing the intended endpoint contract.
- API family: Management API
- Method:
POST - Path:
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/stock/\{warehouse_slug\}/diff - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Variants
- OpenAPI summary: Adjust variant stock by delta