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,8 +1,9 @@
|
||||
title: Product Variant
|
||||
description: >-
|
||||
Product Variants represent a Product with a specific set of Product Option
|
||||
A Product Variant represents a Product with a specific set of Product Option
|
||||
configurations. The maximum number of Product Variants that a Product can have
|
||||
is given by the number of available Product Option combinations.
|
||||
is given by the number of available Product Option combinations. A product
|
||||
must at least have one product variant.
|
||||
type: object
|
||||
required:
|
||||
- allow_backorder
|
||||
@@ -39,19 +40,21 @@ properties:
|
||||
type: string
|
||||
example: Small
|
||||
product_id:
|
||||
description: The ID of the Product that the Product Variant belongs to.
|
||||
description: The ID of the product that the product variant belongs to.
|
||||
type: string
|
||||
example: prod_01G1G5V2MBA328390B5AXJ610F
|
||||
product:
|
||||
description: A product object. Available if the relation `product` is expanded.
|
||||
description: The details of the product that the product variant belongs to.
|
||||
x-expandable: product
|
||||
nullable: true
|
||||
type: object
|
||||
prices:
|
||||
description: >-
|
||||
The Money Amounts defined for the Product Variant. Each Money Amount
|
||||
represents a price in a given currency or a price in a specific Region.
|
||||
Available if the relation `prices` is expanded.
|
||||
The details of the prices of the Product Variant, each represented as a
|
||||
Money Amount. Each Money Amount represents a price in a given currency or
|
||||
a specific Region.
|
||||
type: array
|
||||
x-expandable: prices
|
||||
items:
|
||||
$ref: ./MoneyAmount.yaml
|
||||
sku:
|
||||
@@ -158,16 +161,16 @@ properties:
|
||||
example: null
|
||||
options:
|
||||
description: >-
|
||||
The Product Option Values specified for the Product Variant. Available if
|
||||
the relation `options` is expanded.
|
||||
The details of the product options that this product variant defines
|
||||
values for.
|
||||
type: array
|
||||
x-expandable: options
|
||||
items:
|
||||
$ref: ./ProductOptionValue.yaml
|
||||
inventory_items:
|
||||
description: >-
|
||||
The Inventory Items related to the product variant. Available if the
|
||||
relation `inventory_items` is expanded.
|
||||
description: The details inventory items of the product variant.
|
||||
type: array
|
||||
x-expandable: inventory_items
|
||||
items:
|
||||
$ref: ./ProductVariantInventoryItem.yaml
|
||||
created_at:
|
||||
@@ -189,6 +192,10 @@ properties:
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
purchasable:
|
||||
description: |
|
||||
Only used with the inventory modules.
|
||||
|
||||
Reference in New Issue
Block a user