asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated API Reference (automated) (#9962)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-11-07 09:14:58 +01:00
committed by GitHub
co-authored by olivermrbl
parent 0fbee723b4
commit 242d00b567
46 changed files with 1083 additions and 471 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/openapi.full.yaml
+123 -74
View File
@@ -10192,6 +10192,7 @@ components:
- product_title
- product_description
- product_subtitle
- product_type_id
- product_type
- product_collection
- product_handle
@@ -10378,6 +10379,10 @@ components:
type: number
title: refundable_total_per_unit
description: The total refundable amount of the item's total for a single quantity.
product_type_id:
type: string
title: product_type_id
description: The item's product type id.
AdminOrderPreview:
type: object
description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
@@ -17771,6 +17776,7 @@ components:
- product_title
- product_description
- product_subtitle
- product_type_id
- product_type
- product_collection
- product_handle
@@ -17971,6 +17977,10 @@ components:
type: number
title: refundable_total_per_unit
description: The total refundable amount of the item's total for a single quantity.
product_type_id:
type: string
title: product_type_id
description: The item's product type id.
BaseOrderLineItemAdjustment:
type: object
description: The adjustment's details.
@@ -18757,30 +18767,33 @@ components:
- updated_at
- deleted_at
properties:
id:
type: string
title: id
description: The product's ID.
collection:
$ref: '#/components/schemas/BaseCollection'
categories:
type: array
description: The product's categories.
items:
$ref: '#/components/schemas/BaseProductCategory'
variants:
type: array
description: The product's variants.
items:
type: object
type:
$ref: '#/components/schemas/BaseProductType'
tags:
type: array
description: The product's tags.
items:
$ref: '#/components/schemas/BaseProductTag'
length:
type: number
title: length
description: The product's length.
title:
type: string
title: title
description: The product's title.
handle:
type: string
title: handle
description: The product's handle.
subtitle:
type: string
title: subtitle
description: The product's subtitle.
description:
type: string
title: description
description: The product's description.
is_giftcard:
type: boolean
title: is_giftcard
description: Whether the product is a gift card.
status:
type: string
description: The product's status.
@@ -18789,10 +18802,48 @@ components:
- proposed
- published
- rejected
options:
type: array
description: The product's options.
items:
$ref: '#/components/schemas/BaseProductOption'
description:
type: string
title: description
description: The product's description.
id:
type: string
title: id
description: The product's ID.
metadata:
type: object
description: The product's metadata, can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The date the product was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the product was updated.
handle:
type: string
title: handle
description: The product's unique handle.
subtitle:
type: string
title: subtitle
description: The product's subtitle.
is_giftcard:
type: boolean
title: is_giftcard
description: Whether the product is a gift card.
thumbnail:
type: string
title: thumbnail
description: The product's thumbnail URL.
description: The product's thumbnail.
width:
type: number
title: width
@@ -18801,10 +18852,6 @@ components:
type: number
title: weight
description: The product's weight.
length:
type: number
title: length
description: The product's length.
height:
type: number
title: height
@@ -18816,47 +18863,23 @@ components:
hs_code:
type: string
title: hs_code
description: The product's hs code.
description: The product's HS code.
mid_code:
type: string
title: mid_code
description: The product's mid code.
description: The product's MID code.
material:
type: string
title: material
description: The product's material.
collection:
$ref: '#/components/schemas/BaseCollection'
collection_id:
type: string
title: collection_id
description: The ID of the collection the product belongs to.
categories:
type: array
description: The product's categories.
items:
$ref: '#/components/schemas/BaseProductCategory'
type:
$ref: '#/components/schemas/BaseProductType'
description: The ID of the collection that the product belongs to.
type_id:
type: string
title: type_id
description: The ID of the type the product belongs to.
tags:
type: array
description: The product's tags.
items:
$ref: '#/components/schemas/BaseProductTag'
variants:
type: array
description: The product's variants.
items:
type: object
options:
type: array
description: The product's options.
items:
$ref: '#/components/schemas/BaseProductOption'
description: The ID of the product's type.
images:
type: array
description: The product's images.
@@ -18865,29 +18888,16 @@ components:
discountable:
type: boolean
title: discountable
description: Whether the product is discountable.
description: Whether discounts can be applied on the product.
external_id:
type: string
title: external_id
description: The ID of the product in an external or third-party system.
created_at:
type: string
format: date-time
title: created_at
description: The date the product was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the product was updated.
description: The ID of a product in an external system, such as an ERP or CMS.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the product was deleted.
metadata:
type: object
description: The product's metadata, can hold custom key-value pairs.
BaseProductCategory:
type: object
description: The product category's details.
@@ -18911,9 +18921,9 @@ components:
type: array
description: The category's children.
items:
type: object
$ref: '#/components/schemas/AdminProductCategory'
parent_category:
type: object
$ref: '#/components/schemas/AdminProductCategory'
products:
type: array
description: The category's products.
@@ -20158,6 +20168,7 @@ components:
required:
- id
- version
- display_id
- status
- currency_code
- created_at
@@ -20360,6 +20371,10 @@ components:
type: number
title: original_shipping_tax_total
description: The total taxes of the order's shipping excluding promotions.
display_id:
type: number
title: display_id
description: The order's display id.
OrderAddress:
type: object
description: The address's details.
@@ -20822,8 +20837,19 @@ components:
title: no_notification
description: Whether to send the customer notifications when the exchange is updated.
difference_due:
type: number
title: difference_due
oneOf:
- type: string
title: difference_due
description: The exchange's difference due.
- type: number
title: difference_due
description: The exchange's difference due.
- type: string
title: difference_due
description: The exchange's difference due.
- type: number
title: difference_due
description: The exchange's difference due.
description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
return:
$ref: '#/components/schemas/Return'
@@ -21172,6 +21198,10 @@ components:
type: number
title: refundable_total_per_unit
description: The total amount that can be refunded of a single quantity of the item.
product_type_id:
type: string
title: product_type_id
description: The item's product type id.
OrderLineItemAdjustment:
type: object
description: The line item adjustment's details.
@@ -21702,8 +21732,19 @@ components:
- received
- partially_received
refund_amount:
type: number
title: refund_amount
oneOf:
- type: string
title: refund_amount
description: The return order's refund amount.
- type: number
title: refund_amount
description: The return order's refund amount.
- type: string
title: refund_amount
description: The return order's refund amount.
- type: number
title: refund_amount
description: The return order's refund amount.
description: The amount refunded by this return.
order_id:
type: string
@@ -23693,6 +23734,7 @@ components:
- product_title
- product_description
- product_subtitle
- product_type_id
- product_type
- product_collection
- product_handle
@@ -27676,6 +27718,10 @@ components:
type: number
title: refundable_total_per_unit
description: The total refundable amount of the item's total for a single quantity.
product_type_id:
type: string
title: product_type_id
description: The item's product type id.
StoreOrderResponse:
type: object
description: The order's details.
@@ -30543,6 +30589,9 @@ components:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
UpdateAddress:
type: object
description: The details to update in the address.