Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Inventory Items
  • Auth
    • Get Current User
      GET
    • User Logout
      DELETE
    • User Login
      POST
    • User Login (JWT)
      POST
  • Apps Oauth
    • Generate Token for App
      POST
    • List Applications
      GET
  • Batch Jobs
    • Cancel a Batch Job
      POST
    • Get a Batch Job
      GET
    • Confirm a Batch Job
      POST
    • List Batch Jobs
      GET
    • Create a Batch Job
      POST
  • Currencies
    • List Currency
      GET
    • Update a Currency
      POST
  • Customers
    • Create a Customer
      POST
    • List Customers
      GET
    • Update a Customer
      POST
    • Get a Customer
      GET
  • Customer Groups
    • Remove Customers from Group
    • Add Customers to Group
    • List Customers
    • Create a Customer Group
    • List Customer Groups
    • Get a Customer Group
    • Delete a Customer Group
    • Update a Customer Group
  • Discounts
    • Create a Condition
    • Create a Discount
    • List Discounts
    • Get a Condition
    • Update a Condition
    • Delete a Condition
    • Create a Dynamic Code
    • Remove Batch Resources
    • Add Batch Resources
    • Get Discount by Code
    • Delete a Dynamic Code
    • Add Region to Discount
    • Remove Region
    • Delete a Discount
    • Update a Discount
    • Get a Discount
  • Draft Orders
    • Create a Line Item
    • Delete a Line Item
    • Update a Line Item
    • Update a Draft Order
    • Delete a Draft Order
    • Get a Draft Order
    • Create a Draft Order
    • List Draft Orders
    • Mark Paid
  • Gift Cards
    • Create a Gift Card
    • List Gift Cards
    • Delete a Gift Card
    • Get a Gift Card
    • Update a Gift Card
  • Inventory Items
    • Create an Inventory Item
      POST
    • List Inventory Items
      GET
    • List Inventory Level
      GET
    • Create an Location Level
      POST
    • Update an Inventory Item
      POST
    • Get an Inventory Item
      GET
    • Delete an Inventory Item
      DELETE
    • Update a Location Level
      POST
    • Delete a Location Level
      DELETE
  • Invites
    • Lists Invites
    • Create an Invite
    • Delete an Invite
    • Accept an Invite
    • Resend an Invite
  • Notes
    • List Notes
    • Create a Note
    • Get a Note
    • Delete a Note
    • Update a Note
  • Notifications
    • Resend Notification
    • List Notifications
  • Orders
    • Create a Reservation
    • Cancel Claim's Fulfillment
    • Ship a Claim's Fulfillment
    • Cancel Swap's Fulfilmment
    • Get Order Reservations
    • Add a Shipping Method
    • Create a Refund
    • Get an Order
    • Update an Order
    • Create a Fulfillment
    • Cancel a Swap
    • List Orders
    • Create a Swap
    • Complete an Order
    • Create a Swap Fulfillment
    • Cancel a Claim
    • Process a Swap Payment
    • Ship a Fulfillment
    • Capture an Order's Payments
    • Archive Order
    • Update a Claim
    • Request a Return
    • Create a Claim Fulfillment
    • Ship a Swap's Fulfillment
    • Cancel a Fulfilmment
    • Create a Claim
    • Cancel an Order
  • Order Edits
    • Delete a Line Item Change
    • Add a Line Item
    • Upsert Line Item Change
    • Delete Line Item
    • Cancel an Order Edit
    • Delete an Order Edit
    • Get an Order Edit
    • Update an Order Edit
    • Request Confirmation
    • Create an OrderEdit
    • List Order Edits
    • Confirm an OrderEdit
  • Payments
    • Capture a Payment
    • Get Payment details
    • Refund Payment
  • Payment Collections
    • Delete a Payment Collection
    • Get a Payment Collection
    • Update Payment Collection
    • Mark Authorized
  • Product Collections
    • Add Products to Collection
    • Remove Products from Collection
    • Get a Collection
    • Update a Collection
    • Delete a Collection
    • List Collections
    • Create a Collection
  • Product Tags
    • List Product Tags
  • Product Types
    • List Product Types
  • Product Variants
    • Get Variant's Inventory
    • List Product Variants
    • Get a Product variant
  • Price Lists
    • Delete a Product's Prices
    • List Products
    • Delete a Variant's Prices
    • Get a Price List
    • Update a Price List
    • Delete a Price List
    • Add or Update Prices
    • Delete Prices
    • Create a Price List
    • List Price Lists
  • Products
    • List Product Types
    • List Tags Usage Number
    • List a Product's Variants
    • Create a Product Variant
    • Update a Product Variant
    • Delete a Product Variant
    • Add a Product Option
    • Set Metadata
    • Delete a Product Option
    • Update a Product Option
    • List Products
    • Create a Product
    • Delete a Product
    • Update a Product
    • Get a Product
  • Product Categories
    • Create a Product Category
    • List Product Categories
    • Update a Product Category
    • Delete a Product Category
    • Get a Product Category
    • Add Products to a Category
    • Remove Products from Category
  • Publishable Api Keys
    • List Sales Channels
    • Delete Publishable API Key
    • Get a Publishable API Key
    • Revoke a Publishable API Key
    • Remove Sales Channels
    • Add Sales Channels
    • Update Publishable API Key
    • List Publishable API keys
    • Create Publishable API Key
  • Reservations
    • Delete a Reservation
    • Update a Reservation
    • Get a Reservation
    • Create a Reservation
    • List Reservations
  • Regions
    • List Fulfillment Options
    • Add Country
    • Remove Fulfillment Provider
    • Remove Payment Provider
    • Add Payment Provider
    • Delete a Region
    • Update a Region
    • Get a Region
    • List Regions
    • Create a Region
    • Add Fulfillment Provider
    • Remove Country
  • Return Reasons
    • Get a Return Reason
    • Delete a Return Reason
    • Update a Return Reason
    • List Return Reasons
    • Create a Return Reason
  • Returns
    • Receive a Return
    • List Returns
    • Cancel a Return
  • Sales Channels
    • Remove Stock Location from Sales Channels.
    • Associate a Stock Location
    • Get a Sales Channel
    • Delete a Sales Channel
    • Update a Sales Channel
    • Remove Products from Sales Channel
    • Add Products to Sales Channel
    • Create a Sales Channel
    • List Sales Channels
  • Shipping Options
    • Update Shipping Option
    • Get a Shipping Option
    • Delete Shipping Option
    • List Shipping Options
    • Create Shipping Option
  • Shipping Profiles
    • List Shipping Profiles
    • Create a Shipping Profile
    • Delete a Shipping Profile
    • Update a Shipping Profile
    • Get a Shipping Profile
  • Stock Locations
    • Get a Stock Location
    • List Stock Locations
    • Create a Stock Location
    • Update a Stock Location
    • Delete a Stock Location
  • Store
    • List Payment Providers
    • Add a Currency Code
    • Remove a Currency
    • List Tax Providers
    • Update Store Details
    • Get Store details
  • Swaps
    • Get a Swap
    • List Swaps
  • Uploads
    • Upload Files
    • Delete an Uploaded File
    • Get a File's Download URL
    • Protected File Upload
  • Tax Rates
    • Add to Shipping Options
    • Remove Shipping Options from Rate
    • Create a Tax Rate
    • List Tax Rates
    • Add to Products
    • Remove Products from Rate
    • Delete a Tax Rate
    • Get a Tax Rate
    • Update a Tax Rate
    • Add to Product Types
    • Remove Product Types from Rate
  • Users
    • Reset Password
    • Request Password Reset
    • Get a User
    • Delete a User
    • Update a User
    • Create a User
    • List Users
  1. Inventory Items

Create an Inventory Item

POST
/admin/inventory-items
Inventory Items
Create an Inventory Item for a product variant.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST '{{BASE_URL}}/admin/inventory-items' \
--header 'Content-Type: application/json' \
--data-raw '{
    "variant_id": "string",
    "sku": "string",
    "ean": "string",
    "upc": "string",
    "barcode": "string",
    "hs_code": "string",
    "inventory_quantity": 0,
    "allow_backorder": true,
    "manage_inventory": true,
    "weight": 0,
    "length": 0,
    "height": 0,
    "width": 0,
    "origin_country": "string",
    "mid_code": "string",
    "material": "string",
    "metadata": {}
}'
Response Response Example
200 - Example 1
{
  "inventory_item": {
    "sku": "string",
    "hs_code": "string",
    "origin_country": "string",
    "mid_code": "string",
    "title": "string",
    "description": "string",
    "thumbnail": "string",
    "material": "string",
    "weight": 0,
    "height": 0,
    "width": 0,
    "length": 0,
    "requires_shipping": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "metadata": {
      "car": "white"
    }
  }
}

Request

Query Params
expand
string 
optional
Comma-separated relations that should be expanded in the returned inventory item.
fields
string 
optional
Comma-separated fields that should be included in the returned inventory item.
Body Params application/json
variant_id
string 
required
The ID of the variant to create the inventory item for.
sku
string 
optional
The unique SKU of the associated Product Variant.
ean
string 
optional
The EAN number of the item.
upc
string 
optional
The UPC number of the item.
barcode
string 
optional
A generic GTIN field for the Product Variant.
hs_code
string 
optional
The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.
inventory_quantity
integer 
optional
The amount of stock kept of the associated Product Variant.
Default:
0
allow_backorder
boolean 
optional
Whether the associated Product Variant can be purchased when out of stock.
manage_inventory
boolean 
optional
Whether Medusa should keep track of the inventory for the associated Product Variant.
Default:
true
weight
number 
optional
The weight of the Inventory Item. May be used in shipping rate calculations.
length
number 
optional
The length of the Inventory Item. May be used in shipping rate calculations.
height
number 
optional
The height of the Inventory Item. May be used in shipping rate calculations.
width
number 
optional
The width of the Inventory Item. May be used in shipping rate calculations.
origin_country
string 
optional
The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.
mid_code
string 
optional
The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.
material
string 
optional
The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.
metadata
object 
optional
An optional set of key-value pairs with additional information.
Examples

Responses

🟢200OK
application/json
Body
inventory_item
object (InventoryItemDTO) 
required
sku
string 
required
The Stock Keeping Unit (SKU) code of the Inventory Item.
hs_code
string 
optional
The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.
origin_country
string 
optional
The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.
mid_code
string 
optional
The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.
title
string 
optional
Title of the inventory item
description
string 
optional
Description of the inventory item
thumbnail
string 
optional
Thumbnail for the inventory item
material
string 
optional
The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.
weight
number 
optional
The weight of the Inventory Item. May be used in shipping rate calculations.
height
number 
optional
The height of the Inventory Item. May be used in shipping rate calculations.
width
number 
optional
The width of the Inventory Item. May be used in shipping rate calculations.
length
number 
optional
The length of the Inventory Item. May be used in shipping rate calculations.
requires_shipping
boolean 
optional
Whether the item requires shipping.
created_at
string <date-time>
optional
The date with timezone at which the resource was created.
updated_at
string <date-time>
optional
The date with timezone at which the resource was updated.
deleted_at
string <date-time>
optional
The date with timezone at which the resource was deleted.
metadata
object 
optional
An optional key-value map with additional details
Example:
{"car":"white"}
🟠400Client Error or Multiple Errors
🟠401User is not authorized. Must log in first
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Modified at 2023-10-10 11:56:36
Previous
Update a Gift Card
Next
List Inventory Items
Built with