Medusa
  1. Products
Medusa
  • Store API
  • Admin API
    • Auth
      • Apps Oauth
        • Generate Token for App
        • List Applications
      • Get Current User
        GET
      • User Logout
        DELETE
      • User Login
        POST
      • User Login (JWT)
        POST
    • 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
      • List Customers
      • Update a Customer
      • Get a Customer
    • 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
      • List Inventory Items
      • List Inventory Level
      • Create an Location Level
      • Update an Inventory Item
      • Get an Inventory Item
      • Delete an Inventory Item
      • Update a Location Level
      • Delete a Location Level
    • 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
        GET
      • List Tags Usage Number
        GET
      • List a Product's Variants
        GET
      • Create a Product Variant
        POST
      • Update a Product Variant
        POST
      • Delete a Product Variant
        DELETE
      • Add a Product Option
        POST
      • Set Metadata
        POST
      • Delete a Product Option
        DELETE
      • Update a Product Option
        POST
    • 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
      • Update a Stock Location
      • Delete a Stock Location
      • List Stock Locations
      • Create 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
  • 【Demo】Products
    • 检索产品列表
    • 创建新产品
    • 删除产品
    • 更新产品信息
    • 检索产品详情
  1. Products

Update a Product Variant

POST
/admin/products/{id}/variants/{variant_id}
Admin API/ProductsProducts
Update a Product Variant's details.

Request

Path Params
id
string 
required
The ID of the Product.
variant_id
string 
required
The ID of the Product Variant.
Body Params application/json
title
string 
optional
The title of the product variant.
sku
string 
optional
The unique SKU of the 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 of the product variant.
hs_code
string 
optional
The Harmonized System code of the product variant.
inventory_quantity
integer 
optional
The amount of stock kept of the product variant.
allow_backorder
boolean 
optional
Whether the product variant can be purchased when out of stock.
manage_inventory
boolean 
optional
Whether Medusa should keep track of the inventory of this product variant.
weight
number 
optional
The weight of the product variant.
length
number 
optional
The length of the product variant.
height
number 
optional
The height of the product variant.
width
number 
optional
The width of the product variant.
origin_country
string 
optional
The country of origin of the product variant.
mid_code
string 
optional
The Manufacturer Identification code of the product variant.
material
string 
optional
The material composition of the product variant.
metadata
object 
optional
An optional set of key-value pairs with additional information.
options
array [object {2}] 
optional
An array of Product Option values that the variant corresponds to.
option_id
string 
required
The ID of the Product Option.
value
string 
required
The value of the Product Option.
prices
array [object {6}] 
optional
An array of product variant prices. A product variant can have different prices for each region or currency code.
id
string 
optional
The ID of the price. If provided, the existing price will be updated. Otherwise, a new price will be created.
region_id
string 
optional
The ID of the Region the price will be used in. This is only required if currency_code is not provided.
amount
integer 
required
The price amount.
min_quantity
integer 
optional
The minimum quantity required to be added to the cart for the price to be used.
max_quantity
integer 
optional
The maximum quantity required to be added to the cart for the price to be used.
currency_code
string 
optional
The 3 character ISO currency code the price will be used in. This is only required if region_id is not provided.
Example
{
  "title": "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": {},
  "options": [
    {
      "option_id": "string",
      "value": "string"
    }
  ],
  "prices": [
    {
      "id": "string",
      "region_id": "string",
      "amount": 0,
      "min_quantity": 0,
      "max_quantity": 0,
      "currency_code": "string"
    }
  ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/admin/products//variants/' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK
application/json
Body
product
object (Priced Product) 
required
产品是一种可销售的商品，包含名称或描述等一般信息。它必须至少包括一个产品，其中每个产品定义了购买产品的不同选项（例如，不同的尺寸或颜色）。产品的价格和库存是在产品级别上定义的。
id
string 
required
产品的ID。
Example:
prod_01G1G5V2MBA328390B5AXJ610F
title
string 
required
可以显示的标题，以便于识别产品。
Example:
Medusa Coffee Mug
subtitle
string  | null 
required
可用于进一步指定产品的可选副标题。
description
string  | null 
required
产品的简短描述。
Example:
Every programmer's best friend.
handle
string  | null 
required
产品的唯一标识符。
Example:
coffee-mug
is_giftcard
boolean 
required
产品是否代表礼品卡。代表礼品卡的产品在购买后将自动生成可兑换的礼品卡代码。
Default:
false
thumbnail
string <uri> | null 
required
可用于标识产品的图像文件的URL。
profile_id
string 
required
产品所属的装运配置文件的ID。装运配置文件有一组定义的装运选项，可用于完成产品。
Example:
sp_01G1G5V239ENSZ5MV4JAR737BM
weight
number  | null 
required
产品的重量。可用于运费计算。
Example:
null
length
number  | null 
required
产品的长度。可用于运费计算。
Example:
null
height
number  | null 
required
产品的高度。可用于运费计算。
Example:
null
width
number  | null 
required
产品的宽度。可用于运费计算。
Example:
null
hs_code
string  | null 
required
产品的协调制度代码。可由履行提供商用于将海关信息传递给运输承运人。
Example:
null
origin_country
string  | null 
required
产品的生产国。可由履行提供商用于将海关信息传递给运输承运人。
Example:
null
mid_code
string  | null 
required
制造商识别码，用于识别产品的制造商。可由履行提供商用于将海关信息传递给运输承运人。
Example:
null
material
string  | null 
required
产品所用的材料和成分可由履行提供商用于将海关信息传递给运输承运人。
Example:
null
collection_id
string  | null 
required
产品所属的产品集合的ID。
Example:
pcol_01F0YESBFAZ0DV6V831JXWH0BG
type_id
string  | null 
required
产品所属的产品类型的ID。
Example:
ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
discountable
boolean 
required
产品是否可以打折。当此标志设置为“false”时，折扣将不适用于本产品的行项目。
Default:
true
external_id
string  | null 
required
产品的外部ID
Example:
null
created_at
string <date-time>
required
创建资源的日期和时区。
updated_at
string <date-time>
required
更新资源的日期和时区。
deleted_at
string <date-time> | null 
required
删除资源的日期和时区。
status
enum<string> 
required
产品的状态
Allowed values:
draftproposedpublishedrejected
Default:
draft
metadata
object  | null 
required
带有附加详细信息的可选键值映射
Example:
{"car":"white"}
images
array[object (Image) {6}] 
optional
产品图像的详细信息。
categories
array[object (Product Category) {13}] 
optional
此产品所属的产品类别的详细信息。
collection
object 
Product Collection
optional
A Product Collection allows grouping together products for promotional purposes. For example, an admin can create a Summer collection, add products to it, and showcase it on the storefront.
tags
array[object (Product Tag) {6}] 
optional
此产品中使用的产品标签的详细信息。
profile
object 
Shipping Profile
optional
A Shipping Profile has a set of defined Shipping Options that can be used to fulfill a given set of Products. For example, gift cards are shipped differently than physical products, so a shipping profile with the type gift_card groups together the shipping options that can only be used for gift cards.
profiles
array[object (Shipping Profile) {9}]  | null 
optional
type
object 
Product Type
optional
A Product Type can be added to Products for filtering and reporting purposes.
sales_channels
array[object (Sales Channel) {9}] 
optional
有关此产品销售渠道的详细信息
options
array[object (Product Option) {9}] 
optional
为产品定义的产品选项的详细信息。产品将具有产品选项值的独特组合。
variants
array[object (Priced Product Variant) {35}] 
optional
属于该产品的产品变体的详细信息。每种产品都将有一个独特的产品选项价值组合。
Example
{
  "product": {
    "id": "prod_01G1G5V2MBA328390B5AXJ610F",
    "title": "Medusa Coffee Mug",
    "subtitle": "string",
    "description": "Every programmer's best friend.",
    "handle": "coffee-mug",
    "is_giftcard": false,
    "thumbnail": "http://example.com",
    "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
    "weight": null,
    "length": null,
    "height": null,
    "width": null,
    "hs_code": null,
    "origin_country": null,
    "mid_code": null,
    "material": null,
    "collection_id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
    "type_id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
    "discountable": true,
    "external_id": null,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "status": "draft",
    "metadata": {
      "car": "white"
    },
    "images": [
      {
        "id": "img_01G749BFYR6T8JTVW6SGW3K3E6",
        "url": "http://example.com",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
          "car": "white"
        }
      }
    ],
    "categories": [
      {
        "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2",
        "name": "Regular Fit",
        "handle": "regular-fit",
        "mpath": "pcat_id1.pcat_id2.pcat_id3",
        "is_internal": false,
        "is_active": false,
        "rank": 0,
        "parent_category_id": null,
        "parent_category": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "category_children": [
          {}
        ],
        "products": [
          {}
        ]
      }
    ],
    "collection": {
      "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
      "title": "Summer Collection",
      "handle": "summer-collection",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "products": [
        {}
      ],
      "metadata": {
        "car": "white"
      }
    },
    "tags": [
      {
        "id": "ptag_01G8K2MTMG9168F2B70S1TAVK3",
        "value": "Pants",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
          "car": "white"
        }
      }
    ],
    "profile": {
      "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
      "name": "Default Shipping Profile",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "type": "default",
      "products": [
        {}
      ],
      "shipping_options": [
        {}
      ],
      "metadata": {
        "car": "white"
      }
    },
    "profiles": [
      {
        "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
        "name": "Default Shipping Profile",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "type": "default",
        "products": [
          {}
        ],
        "shipping_options": [
          {}
        ],
        "metadata": {
          "car": "white"
        }
      }
    ],
    "type": {
      "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
      "value": "Clothing",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "metadata": {
        "car": "white"
      }
    },
    "sales_channels": [
      {
        "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
        "name": "Market",
        "description": "Multi-vendor market",
        "is_disabled": false,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
          "car": "white"
        },
        "locations": [
          {
            "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
            "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
            "location_id": "string",
            "sales_channel": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z"
          }
        ]
      }
    ],
    "options": [
      {
        "id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
        "title": "Size",
        "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
        "product": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
          "car": "white"
        },
        "values": [
          {
            "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
            "value": "large",
            "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
            "option": {},
            "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
            "variant": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
              "car": "white"
            }
          }
        ]
      }
    ],
    "variants": [
      {
        "id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
        "title": "Small",
        "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
        "product": {},
        "sku": "shirt-123",
        "barcode": null,
        "ean": null,
        "upc": null,
        "variant_rank": 0,
        "inventory_quantity": 100,
        "allow_backorder": false,
        "manage_inventory": true,
        "hs_code": null,
        "origin_country": null,
        "mid_code": null,
        "material": null,
        "weight": null,
        "length": null,
        "height": null,
        "width": null,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "purchasable": true,
        "metadata": {
          "car": "white"
        },
        "options": [
          {
            "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
            "value": "large",
            "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
            "option": {},
            "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
            "variant": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
              "car": "white"
            }
          }
        ],
        "inventory_items": [
          {
            "id": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A",
            "inventory_item_id": "string",
            "variant_id": "string",
            "variant": {},
            "required_quantity": 1,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z"
          }
        ],
        "prices": [
          {
            "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
            "amount": 100,
            "min_quantity": 1,
            "max_quantity": 1,
            "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
            "price_list": {},
            "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
            "variant": {},
            "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
            "region": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "currency_code": "usd",
            "currency": {
              "symbol": "$",
              "symbol_native": "$",
              "name": "US Dollar",
              "includes_tax": false,
              "code": "usd"
            }
          }
        ],
        "original_price": 0,
        "calculated_price": 0,
        "original_price_incl_tax": 0,
        "calculated_price_incl_tax": 0,
        "original_tax": 0,
        "calculated_tax": 0,
        "tax_rates": [
          {
            "rate": 0,
            "name": "string",
            "code": "string"
          }
        ]
      }
    ]
  }
}
🟠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 2024-05-23 07:10:14
Previous
Create a Product Variant
Next
Delete a Product Variant
Built with