chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
committed by
GitHub
parent
efdea04963
commit
658339767b
@@ -1,7 +1,7 @@
|
||||
type: object
|
||||
properties:
|
||||
sku:
|
||||
description: The unique SKU for the Product Variant.
|
||||
description: The unique SKU of the associated Product Variant.
|
||||
type: string
|
||||
ean:
|
||||
description: The EAN number of the item.
|
||||
@@ -13,42 +13,64 @@ properties:
|
||||
description: A generic GTIN field for the Product Variant.
|
||||
type: string
|
||||
hs_code:
|
||||
description: The Harmonized System code for the Product Variant.
|
||||
description: >-
|
||||
The Harmonized System code of the Inventory Item. May be used by
|
||||
Fulfillment Providers to pass customs information to shipping carriers.
|
||||
type: string
|
||||
inventory_quantity:
|
||||
description: The amount of stock kept for the Product Variant.
|
||||
description: The amount of stock kept of the associated Product Variant.
|
||||
type: integer
|
||||
default: 0
|
||||
allow_backorder:
|
||||
description: Whether the Product Variant can be purchased when out of stock.
|
||||
description: Whether the associated Product Variant can be purchased when out of stock.
|
||||
type: boolean
|
||||
manage_inventory:
|
||||
description: >-
|
||||
Whether Medusa should keep track of the inventory for this Product
|
||||
Variant.
|
||||
Whether Medusa should keep track of the inventory for the associated
|
||||
Product Variant.
|
||||
type: boolean
|
||||
default: true
|
||||
weight:
|
||||
description: The wieght of the Product Variant.
|
||||
description: >-
|
||||
The weight of the Inventory Item. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
length:
|
||||
description: The length of the Product Variant.
|
||||
description: >-
|
||||
The length of the Inventory Item. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
height:
|
||||
description: The height of the Product Variant.
|
||||
description: >-
|
||||
The height of the Inventory Item. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
width:
|
||||
description: The width of the Product Variant.
|
||||
description: >-
|
||||
The width of the Inventory Item. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
origin_country:
|
||||
description: The country of origin of the Product Variant.
|
||||
description: >-
|
||||
The country in which the Inventory Item was produced. May be used by
|
||||
Fulfillment Providers to pass customs information to shipping carriers.
|
||||
type: string
|
||||
mid_code:
|
||||
description: The Manufacturer Identification code for the Product Variant.
|
||||
description: >-
|
||||
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.
|
||||
type: string
|
||||
material:
|
||||
description: The material composition of the Product Variant.
|
||||
description: >-
|
||||
The material and composition that the Inventory Item is made of, May be
|
||||
used by Fulfillment Providers to pass customs information to shipping
|
||||
carriers.
|
||||
type: string
|
||||
metadata:
|
||||
description: An optional set of key-value pairs with additional information.
|
||||
type: object
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
Reference in New Issue
Block a user