Set variants stock

Bulk-upserts variant warehouse stock by variant_id and warehouse_id.

PUT/api/v2/{team_slug}/{app_slug}/products/variants/stock

Authorization

AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters

team_slugstringrequired

app_slugstringrequired

Request body

requiredapplication/json

stockVariantStockItem[]required

min items 1 · max items 20

Show properties

Array of VariantStockItem

variant_idUUIDrequired

warehouse_idUUIDrequired

quantityintegerrequired

Responses

200

OK (partial success possible)

dataVariant[]required

Show properties

Array of Variant

idUUIDrequired

variant_namestringrequired

variant_numberstringrequired

statusstringrequired

product_idUUIDrequired

variant_group_idUUID | null

Show properties

Any of:

UUID

string<uuid>

null

null

validate_stockboolean

purchase_priceVariantPurchasePrice | null

Show properties

Any of:

VariantPurchasePrice

currencystringrequired

value_centsintegerrequired

null

null

variant_dimensionsProductDimension | null

Show properties

Any of:

ProductDimension

widthinteger

heightinteger

lengthinteger

depthinteger

weightinteger

diameterinteger

capacity_milliliterinteger

null

null

custom_fieldsobject

shipping_attributesstring[] | null

warehouse_stockVariantStock[] | null

Show properties

Array of VariantStock

idUUIDrequired

variant_idUUIDrequired

warehouse_idUUIDrequired

warehouse_namestring

warehouse_slugstring

quantityintegerrequired

inventory_datestring<date-time> | null

available_onlineboolean

created_atstring<date-time>

updated_atstring<date-time> | null

imagesProductImageRef[] | null

Show properties

Array of ProductImageRef

idUUIDrequired

urlstring

titlestring

priorityinteger

videosProductVideoRef[] | null

Show properties

Array of ProductVideoRef

idUUIDrequired

urlstring

titlestring

attributesProductAttribute[] | null

Show properties

Array of ProductAttribute

idUUIDrequired

keystring

template_keystring

template_namestring

namestring

descriptionstring

filterableboolean

translatableboolean

valuesobject

pricesVariantPriceItem[] | null

Show properties

Array of VariantPriceItem

variant_idUUIDrequired

store_group_idUUIDrequired

market_idUUIDrequired

amount_cents_with_taxinteger<int64>

sale_price_cents_with_taxinteger<int64> | null

reference_price_cents_with_taxinteger<int64> | null

on_saleboolean

statusstring

Allowed:activeinactivedraft

sale_start_timestampstring<date-time> | null

sale_end_timestampstring<date-time> | null

listingsVariantListings | null

Show properties

Any of:

VariantListings

smartVariantListing[] | null

Show properties

Array of VariantListing

idUUIDrequired

slugstringrequired

staticVariantListing[] | null

null

null

translationsVariantTranslations | null

Show properties

Any of:

VariantTranslations

nameTranslation[] | null

Show properties

Array of Translation

idUUID

localestring

valuestring

null

null

created_atstring<date-time>required

updated_atstring<date-time> | null

errorsVariantError[]required

Show properties

Array of VariantError

variant_numberstring

product_idUUID | null

Show properties

Any of:

UUID

string<uuid>

null

null

idUUID | null

Show properties

Any of:

UUID

string<uuid>

null

null

messagestringrequired

400

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

401

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

403

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

500

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

team_slugpath*app_slugpath*

Bodyapplication/json

Request body

Request

curl -X PUT 'https://api.enad.io/api/v2/string/string/products/variants/stock' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "stock": [
    {
      "variant_id": "8a2d415d-59aa-4132-bef3-011f97c4a0f6",
      "warehouse_id": "825f5f2b-307c-4cc1-9373-6d0c4692d478",
      "quantity": 0
    }
  ]
}'

const response = await fetch("https://api.enad.io/api/v2/string/string/products/variants/stock", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"stock\": [\n    {\n      \"variant_id\": \"8a2d415d-59aa-4132-bef3-011f97c4a0f6\",\n      \"warehouse_id\": \"825f5f2b-307c-4cc1-9373-6d0c4692d478\",\n      \"quantity\": 0\n    }\n  ]\n}"
});

import requests

response = requests.put(
    "https://api.enad.io/api/v2/string/string/products/variants/stock",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"stock\": [\n    {\n      \"variant_id\": \"8a2d415d-59aa-4132-bef3-011f97c4a0f6\",\n      \"warehouse_id\": \"825f5f2b-307c-4cc1-9373-6d0c4692d478\",\n      \"quantity\": 0\n    }\n  ]\n}",
)

Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "variant_name": "string",
      "variant_number": "string",
      "status": "string",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "variant_group_id": "165b9130-4dfe-4a17-99a4-9e5031dcac26",
      "validate_stock": true,
      "purchase_price": {
        "currency": "string",
        "value_cents": 0
      },
      "variant_dimensions": {
        "width": 0,
        "height": 0,
        "length": 0,
        "depth": 0,
        "weight": 0,
        "diameter": 0,
        "capacity_milliliter": 0
      },
      "custom_fields": {
        "property1": "string",
        "property2": "string"
      },
      "shipping_attributes": [
        "string"
      ],
      "warehouse_stock": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "variant_id": "8a2d415d-59aa-4132-bef3-011f97c4a0f6",
          "warehouse_id": "825f5f2b-307c-4cc1-9373-6d0c4692d478",
          "warehouse_name": "string",
          "warehouse_slug": "string",
          "quantity": 0,
          "inventory_date": "2019-08-24T14:15:22Z",
          "available_online": true,
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
      "images": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "url": "string",
          "title": "string",
          "priority": 0
        }
      ],
      "videos": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "url": "string",
          "title": "string"
        }
      ],
      "attributes": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "key": "string",
          "template_key": "string",
          "template_name": "string",
          "name": "string",
          "description": "string",
          "filterable": true,
          "translatable": true,
          "values": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "prices": [
        {
          "variant_id": "8a2d415d-59aa-4132-bef3-011f97c4a0f6",
          "store_group_id": "6c760e36-a704-4b09-93bb-c191a46ca67f",
          "market_id": "6364d859-8e1b-477a-bacc-de8305a9292b",
          "amount_cents_with_tax": 0,
          "sale_price_cents_with_tax": 0,
          "reference_price_cents_with_tax": 0,
          "on_sale": true,
          "status": "active",
          "sale_start_timestamp": "2019-08-24T14:15:22Z",
          "sale_end_timestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "listings": {
        "smart": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "slug": "string"
          }
        ],
        "static": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "slug": "string"
          }
        ]
      },
      "translations": {
        "name": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "locale": "string",
            "value": "string"
          }
        ]
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "errors": [
    {
      "variant_number": "string",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "message": "string"
    }
  ]
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}