Set variant warehouse stock

Creates or updates the stock quantity for a variant in a specific warehouse. If the stock record exists, it will be updated; otherwise, a new record will be created.

PUT/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/stock

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

management-api:PUT:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/stock

Creates or updates the stock quantity for a variant in a specific warehouse. If the stock record exists, it will be updated; otherwise, a new record will be created.

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: PUT
Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/stock
Summary: Set variant warehouse stock
Description: Creates or updates the stock quantity for a variant in a specific warehouse. If the stock record exists, it will be updated; otherwise, a new record will be created.
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.

Parameters4 parameters

Name	In	Required	Type	Description
product_id	path	Yes	string	Product ID
variant_id	path	Yes	string	Variant ID
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug

Request bodyDocumented body

Required: Yes
Description: Variant stock data
Content: application/json (object)

Input Variant Stock

Property	Type	Required	Details
`inventory_date`	string	No	ISO 8601 date format with time zone e.g. 2024-12-12T09:13:31.039Z.
`quantity`	integer	No	-
`warehouse_slug`	string	Yes	-

Generated example (synthetic):

{
  "inventory_date": "string",
  "quantity": 0,
  "warehouse_slug": "string"
}

Responses4 statuses

Status	Description	Content
200	Warehouse stock for variant created or updated successfully	application/json (object)
400	Invalid request (e.g. bad UUID, validation error)	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: PUT
Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/stock
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Variants
OpenAPI summary: Set variant warehouse stock