Set Stock for Multiple Variants

Updates or creates stock quantities for multiple product variants across different warehouses in a single bulk operation. Each item in the request specifies a variant ID, warehouse slug, and the new stock quantity with an optional inventory date. Returns lists of successful and failed operations.

PUT/api/v1/{team_slug}/{app_slug}/variants/stock/bulk
API
Management
Updated
Apr 26, 2026

management-api:PUT:/api/v1/{team_slug}/{app_slug}/variants/stock/bulk

Updates or creates stock quantities for multiple product variants across different warehouses in a single bulk operation. Each item in the request specifies a variant ID, warehouse slug, and the new stock quantity with an optional inventory date. Returns lists of successful and failed operations.

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\}/variants/stock/bulk
  • Summary: Set Stock for Multiple Variants
  • Description: Updates or creates stock quantities for multiple product variants across different warehouses in a single bulk operation. Each item in the request specifies a variant ID, warehouse slug, and the new stock quantity with an optional inventory date. Returns lists of successful and failed operations.
  • 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.

Parameters2 parameters
NameInRequiredTypeDescription
team_slugpathYesstringTeam slug
app_slugpathYesstringApp slug
Request bodyDocumented body
  • Required: Yes
  • Description: Stock data to set
  • Content: application/json (object)

Bulk Set Stock Payload

PropertyTypeRequiredDetails
itemsobject[]YesmaxItems: 100

Bulk Set Stock Item

PropertyTypeRequiredDetails
inventory_datestringNo-
quantityintegerNo-
variant_idstringYes-
warehouse_slugstringYes-

Generated example (synthetic):

{
  "items": [
    {
      "inventory_date": "string",
      "quantity": 0,
      "variant_id": "string",
      "warehouse_slug": "string"
    }
  ]
}
Responses4 statuses
StatusDescriptionContent
200Stock set successfullyapplication/json (object)
400Invalid requestapplication/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Bulk Set Stock Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Bulk Set Stock
PropertyTypeRequiredDetails
failed_setsobject[]No-
successful_setsobject[]No-
Bulk Stock Failed Op
PropertyTypeRequiredDetails
reasonstringNo-
variant_idstringNo-
warehouse_slugstringNo-
Warehouse Variant Stock
PropertyTypeRequiredDetails
available_onlinebooleanNo-
created_atstringNo-
idstringNo-
inventory_datestringNo-
quantityintegerNo-
updated_atstringNo-
warehouse_namestringNo-
warehouse_slugstringNo-

Generated example (synthetic):

{
  "data": {
    "failed_sets": [
      {
        "reason": "string",
        "variant_id": "string",
        "warehouse_slug": "string"
      }
    ],
    "successful_sets": [
      {
        "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

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

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\}/variants/stock/bulk
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Variants, Bulk
  • OpenAPI summary: Set Stock for Multiple Variants

Set Stock for Multiple Variants

# Set Stock for Multiple Variants Updates or creates stock quantities for multiple product variants across different warehouses in a single bulk operation. Each item in the request specifies a variant ID, warehouse slug, and the new stock quantity with an optional inventory date. Returns lists of successful and failed operations.
PUT /api/v1/{team_slug}/{app_slug}/variants/stock/bulk
Purpose

Updates or creates stock quantities for multiple product variants across different warehouses in a single bulk operation.

Required inputs

team_slug path app_slug path

Primary response

200 ยท Stock set successfully

Operation key

management-api:PUT:/api/v1/{team_slug}/{app_slug}/variants/stock/bulk

## 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](/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}/variants/stock/bulk` - Summary: Set Stock for Multiple Variants - Description: Updates or creates stock quantities for multiple product variants across different warehouses in a single bulk operation. Each item in the request specifies a variant ID, warehouse slug, and the new stock quantity with an optional inventory date. Returns lists of successful and failed operations. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/variants/stock/bulk` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | team_slug | path | Yes | string | Team slug | | app_slug | path | Yes | string | App slug | ## Request body - Required: Yes - Description: Stock data to set - Content: application/json (object) ### Bulk Set Stock Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `items` | object[] | Yes | maxItems: 100 | #### Bulk Set Stock Item | Property | Type | Required | Details | | --- | --- | --- | --- | | `inventory_date` | string | No | - | | `quantity` | integer | No | - | | `variant_id` | string | Yes | - | | `warehouse_slug` | string | Yes | - | **Generated example (synthetic):** ```json { "items": [ { "inventory_date": "string", "quantity": 0, "variant_id": "string", "warehouse_slug": "string" } ] } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Stock set successfully | application/json (object) | | 400 | Invalid request | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Bulk Set 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 | - | ##### Bulk Set Stock | Property | Type | Required | Details | | --- | --- | --- | --- | | `failed_sets` | object[] | No | - | | `successful_sets` | object[] | No | - | ##### Bulk Stock Failed Op | Property | Type | Required | Details | | --- | --- | --- | --- | | `reason` | string | No | - | | `variant_id` | string | No | - | | `warehouse_slug` | string | 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):** ```json { "data": { "failed_sets": [ { "reason": "string", "variant_id": "string", "warehouse_slug": "string" } ], "successful_sets": [ { "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):** ```json { "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):** ```json { "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):** ```json { "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}/variants/stock/bulk` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/variants/stock/bulk` - OpenAPI tag: Variants, Bulk - OpenAPI summary: Set Stock for Multiple Variants