POST
/
admin
/
inventory-items
/
{id}
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.inventoryItem.update("iitem_123", {
  sku: "SHIRT"
})
.then(({ inventory_item }) => {
  console.log(inventory_item)
})
{
  "inventory_item": {
    "id": "<string>",
    "sku": "<string>",
    "origin_country": "<string>",
    "hs_code": "<string>",
    "requires_shipping": true,
    "mid_code": "<string>",
    "material": "<string>",
    "weight": 123,
    "length": 123,
    "height": 123,
    "width": 123,
    "title": "<string>",
    "description": "<string>",
    "thumbnail": "<string>",
    "metadata": {},
    "location_levels": [
      {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "inventory_item_id": "<string>",
        "location_id": "<string>",
        "stocked_quantity": 123,
        "reserved_quantity": 123,
        "incoming_quantity": 123,
        "metadata": {},
        "inventory_item": {},
        "available_quantity": 123
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The inventory item's ID.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The properties to update in the inventory item.

​
sku
string

The inventory item's SKU.

​
hs_code
string

The inventory item's HS code.

​
weight
number

The inventory item's weight.

​
length
number

The inventory item's length.

​
height
number

The inventory item's height.

​
width
number

The inventory item's width.

​
origin_country
string

The inventory item's origin country.

​
mid_code
string

The inventory item's MID code.

​
material
string

The inventory item's material.

​
title
string

The inventory item's title.

​
description
string

The inventory item's description.

​
requires_shipping
boolean

Whether the inventory item requires shipping.

​
thumbnail
string

The URL of an image to be used as the inventory item's thumbnail. You can use the Upload API routes to upload an image and get its URL.

​
metadata
object

The inventory item's metadata. Can be custom data in key-value pairs.

Response

OK

The inventory item's details.

​
inventory_item
object
required

The inventory item's details.