chore(docs): Generated API Reference (#3262)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-14 20:32:28 +02:00
committed by GitHub
co-authored by olivermrbl
parent 67f9429293
commit 4fb22e8ba5
122 changed files with 8682 additions and 3866 deletions
+72 -31
View File
@@ -5,12 +5,35 @@ description: >-
the properties that Product Variants differ by.
type: object
required:
- title
- collection_id
- created_at
- deleted_at
- description
- discountable
- external_id
- handle
- height
- hs_code
- id
- is_giftcard
- length
- material
- metadata
- mid_code
- origin_country
- profile_id
- status
- subtitle
- type_id
- thumbnail
- title
- updated_at
- weight
- width
properties:
id:
type: string
description: The product's ID
type: string
example: prod_01G1G5V2MBA328390B5AXJ610F
title:
description: A title that can be displayed for easy identification of the Product.
@@ -18,13 +41,16 @@ properties:
example: Medusa Coffee Mug
subtitle:
description: An optional subtitle that can be used to further specify the Product.
nullable: true
type: string
description:
description: A short description of the Product.
nullable: true
type: string
example: Every programmer's best friend.
handle:
description: A unique identifier for the Product (e.g. for slug structure).
nullable: true
type: string
example: coffee-mug
is_giftcard:
@@ -50,6 +76,7 @@ properties:
$ref: ./Image.yaml
thumbnail:
description: A URL to an image file that can be used to identify the Product.
nullable: true
type: string
format: uri
options:
@@ -68,6 +95,13 @@ properties:
type: array
items:
$ref: ./ProductVariant.yaml
categories:
description: >-
The product's associated categories. Available if the relation
`categories` are expanded.
type: array
items:
$ref: ./ProductCategory.yaml
profile_id:
description: >-
The ID of the Shipping Profile that the Product belongs to. Shipping
@@ -77,41 +111,48 @@ properties:
example: sp_01G1G5V239ENSZ5MV4JAR737BM
profile:
description: Available if the relation `profile` is expanded.
nullable: true
$ref: ./ShippingProfile.yaml
weight:
description: >-
The weight of the Product Variant. May be used in shipping rate
calculations.
type: number
example: null
height:
description: >-
The height of the Product Variant. May be used in shipping rate
calculations.
type: number
example: null
width:
description: >-
The width of the Product Variant. May be used in shipping rate
calculations.
nullable: true
type: number
example: null
length:
description: >-
The length of the Product Variant. May be used in shipping rate
calculations.
nullable: true
type: number
example: null
height:
description: >-
The height of the Product Variant. May be used in shipping rate
calculations.
nullable: true
type: number
example: null
width:
description: >-
The width of the Product Variant. May be used in shipping rate
calculations.
nullable: true
type: number
example: null
hs_code:
description: >-
The Harmonized System code of the Product Variant. May be used by
Fulfillment Providers to pass customs information to shipping carriers.
nullable: true
type: string
example: null
origin_country:
description: >-
The country in which the Product Variant was produced. May be used by
Fulfillment Providers to pass customs information to shipping carriers.
nullable: true
type: string
example: null
mid_code:
@@ -119,6 +160,7 @@ properties:
The Manufacturers Identification code that identifies the manufacturer of
the Product Variant. May be used by Fulfillment Providers to pass customs
information to shipping carriers.
nullable: true
type: string
example: null
material:
@@ -126,23 +168,28 @@ properties:
The material and composition that the Product Variant is made of, May be
used by Fulfillment Providers to pass customs information to shipping
carriers.
nullable: true
type: string
example: null
collection_id:
type: string
description: The Product Collection that the Product belongs to
nullable: true
type: string
example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
collection:
description: >-
A product collection object. Available if the relation `collection` is
expanded.
type: object
nullable: true
$ref: ./ProductCollection.yaml
type_id:
type: string
description: The Product type that the Product belongs to
nullable: true
type: string
example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
type:
description: Available if the relation `type` is expanded.
nullable: true
$ref: ./ProductType.yaml
tags:
description: >-
@@ -159,6 +206,7 @@ properties:
default: true
external_id:
description: The external ID of the product
nullable: true
type: string
example: null
sales_channels:
@@ -167,30 +215,23 @@ properties:
relation `sales_channels` is expanded.
type: array
items:
type: object
description: A sales channel object.
categories:
description: >-
The product's associated categories. Available if the relation
`categories` is expanded.
type: array
items:
type: object
description: A category object.
$ref: ./SalesChannel.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white