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

docs: generate API reference for 2.12.0 (#14185)

Browse Source
This commit is contained in:
Shahed Nasser
2025-12-02 11:56:37 +02:00
committed by GitHub
parent 21f61ec160
commit 9372a17d1f
71 changed files with 6310 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml
+7
View File
@@ -272,3 +272,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml
+7
View File
@@ -677,3 +677,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml
+7
View File
@@ -265,3 +265,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml
+6
View File
@@ -139,3 +139,9 @@ properties:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: >-
Whether promotions from the original order should be carried over to the
order change (specifically, exchanges).
www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeResponse.yaml
+8
View File
@@ -0,0 +1,8 @@
type: object
description: The details of the order change.
x-schemaName: AdminOrderChangeResponse
required:
- order_change
properties:
order_change:
$ref: ./AdminOrderChange.yaml
www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml
+7
View File
@@ -679,3 +679,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml
+2 -1
View File
@@ -11,6 +11,7 @@ required:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -149,7 +150,7 @@ properties:
type: array
description: The variant's images.
items:
$ref: ./AdminProductImage.yaml
$ref: ./BaseProductImage.yaml
thumbnail:
type: string
title: thumbnail
www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml
+8
View File
@@ -69,3 +69,11 @@ properties:
description: >-
Whether the promotion is tax inclusive. If enabled, the promotion is
applied after tax is calculated.
limit:
type: number
title: limit
description: The limit of times the promotion can be used.
used:
type: number
title: used
description: The number of times the promotion has been used.
www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrderChange.yaml
+10
View File
@@ -0,0 +1,10 @@
type: object
description: The data to update in the order change.
x-schemaName: AdminUpdateOrderChange
properties:
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: >-
Whether promotions from the original order should be carried over to the
order change (specifically, exchanges).
www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml
+7
View File
@@ -253,3 +253,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml
+1 -1
View File
@@ -29,7 +29,7 @@ properties:
type: object
description: The image's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
rank:
type: number
www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml
+6
View File
@@ -9,6 +9,7 @@ required:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -138,3 +139,8 @@ properties:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: ./BaseProductImage.yaml
www/apps/api-reference/specs/store/components/schemas/Order.yaml
+7
View File
@@ -321,3 +321,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml
+6
View File
@@ -139,3 +139,9 @@ properties:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: >-
Whether promotions from the original order should be carried over to the
order change (specifically, exchanges).
www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml
+5
View File
@@ -15,6 +15,7 @@ required:
- action
- details
- internal_note
- ordering
- created_at
- updated_at
properties:
@@ -98,3 +99,7 @@ properties:
format: date-time
title: updated_at
description: The date the action was updated.
ordering:
type: number
title: ordering
description: The action's ordering among other actions in the same order change.
www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml
+7
View File
@@ -251,3 +251,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml
+6
View File
@@ -124,6 +124,11 @@ properties:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: ./BaseProductImage.yaml
required:
- options
- length
@@ -139,6 +144,7 @@ required:
- hs_code
- mid_code
- material
- images
- deleted_at
- manage_inventory
- allow_backorder
www/apps/api-reference/specs/store/openapi.full.yaml
+96 -2
View File
@@ -14517,6 +14517,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
AdminDraftOrderListResponse:
type: object
description: The list of draft orders with pagination fields.
@@ -15212,6 +15218,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
AdminDraftOrderPreviewResponse:
type: object
description: The details of the preview on the draft order.
@@ -17027,6 +17039,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
AdminOrderAddress:
type: object
description: An order address.
@@ -17248,6 +17266,10 @@ components:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
AdminOrderChangeAction:
type: object
description: The order change action's details.
@@ -17354,6 +17376,15 @@ components:
type: number
title: ordering
description: The action's order in the sequence of actions.
AdminOrderChangeResponse:
type: object
description: The details of the order change.
x-schemaName: AdminOrderChangeResponse
required:
- order_change
properties:
order_change:
$ref: '#/components/schemas/AdminOrderChange'
AdminOrderChangesResponse:
type: object
description: The details of an order's changes.
@@ -18386,6 +18417,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
AdminOrderPreviewResponse:
type: object
description: The preview of an order.
@@ -20305,6 +20342,7 @@ components:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -20439,7 +20477,7 @@ components:
type: array
description: The variant's images.
items:
$ref: '#/components/schemas/AdminProductImage'
$ref: '#/components/schemas/BaseProductImage'
thumbnail:
type: string
title: thumbnail
@@ -20733,6 +20771,14 @@ components:
type: boolean
title: is_tax_inclusive
description: Whether the promotion is tax inclusive. If enabled, the promotion is applied after tax is calculated.
limit:
type: number
title: limit
description: The limit of times the promotion can be used.
used:
type: number
title: used
description: The number of times the promotion has been used.
AdminPromotionResponse:
type: object
description: The promotion's details.
@@ -23466,6 +23512,15 @@ components:
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
AdminUpdateOrderChange:
type: object
description: The data to update in the order change.
x-schemaName: AdminUpdateOrderChange
properties:
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
AdminUpdatePriceList:
type: object
description: the details to update in a price list.
@@ -26407,6 +26462,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
BaseOrderAddress:
type: object
description: An order address.
@@ -27875,7 +27936,7 @@ components:
type: object
description: The image's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
rank:
type: number
@@ -28066,6 +28127,7 @@ components:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -28191,6 +28253,11 @@ components:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: '#/components/schemas/BaseProductImage'
BasePromotionRuleValue:
type: object
description: The rule value's details.
@@ -29473,6 +29540,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
OrderAddress:
type: object
description: The address's details.
@@ -29691,6 +29764,10 @@ components:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
OrderChangeAction:
type: object
description: The order change action's details.
@@ -29709,6 +29786,7 @@ components:
- action
- details
- internal_note
- ordering
- created_at
- updated_at
properties:
@@ -29792,6 +29870,10 @@ components:
format: date-time
title: updated_at
description: The date the action was updated.
ordering:
type: number
title: ordering
description: The action's ordering among other actions in the same order change.
OrderClaim:
type: object
description: The order change's claim.
@@ -33119,6 +33201,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
StoreOrderAddress:
type: object
description: An order address
@@ -40030,6 +40118,11 @@ components:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: '#/components/schemas/BaseProductImage'
required:
- options
- length
@@ -40045,6 +40138,7 @@ components:
- hs_code
- mid_code
- material
- images
- deleted_at
- manage_inventory
- allow_backorder