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

chore: update API reference for 2.10.2 (#13499)

Browse Source
This commit is contained in:
Shahed Nasser
2025-09-15 12:30:09 +03:00
committed by GitHub
parent 2657f9c196
commit b35b1b41a4
31 changed files with 838 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml
+10
View File
@@ -24,6 +24,7 @@ required:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -37,6 +38,7 @@ required:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -262,3 +264,11 @@ properties:
type: number
title: credit_line_total
description: The draft order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the draft order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml
+10
View File
@@ -24,6 +24,7 @@ required:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -37,6 +38,7 @@ required:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -667,3 +669,11 @@ properties:
type: number
title: credit_line_total
description: The draft order preview's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the draft order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml
+10
View File
@@ -24,6 +24,7 @@ required:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -37,6 +38,7 @@ required:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -255,3 +257,11 @@ properties:
type: number
title: credit_line_total
description: The order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml
+5
View File
@@ -12,6 +12,7 @@ required:
- return_id
- exchange_id
- claim_id
- ordering
- order_change_id
- reference
- reference_id
@@ -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 order in the sequence of actions.
www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml
+10
View File
@@ -26,6 +26,7 @@ required:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -39,6 +40,7 @@ required:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -669,3 +671,11 @@ properties:
type: number
title: credit_line_total
description: The order preview's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml
+10
View File
@@ -123,6 +123,16 @@ properties:
The maximum time in seconds to wait for this step to complete.
If the step exceeds this time, the step's state is changed to
`timeout`, but the step continues executing.
autoRetry:
type: boolean
title: autoRetry
description: Whether the step should be automatically retried if it fails.
maxAwaitingRetries:
type: number
title: maxAwaitingRetries
description: >-
The maximum number of times to retry the step while it's in the
`waiting_response` state.
compensate:
type: object
description: The state of the step's compensation function.
www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml
+10
View File
@@ -23,6 +23,7 @@ required:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -36,6 +37,7 @@ required:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -243,3 +245,11 @@ properties:
type: number
title: credit_line_total
description: The order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
www/apps/api-reference/specs/store/components/schemas/Order.yaml
+10
View File
@@ -15,6 +15,7 @@ required:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -30,6 +31,7 @@ required:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -311,3 +313,11 @@ properties:
type: number
title: credit_line_total
description: The order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml
+10
View File
@@ -22,6 +22,7 @@ required:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -35,6 +36,7 @@ required:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -241,3 +243,11 @@ properties:
type: number
title: credit_line_total
description: The order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
www/apps/api-reference/specs/store/openapi.full.yaml
+83
View File
@@ -13427,6 +13427,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -13440,6 +13441,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -13659,6 +13661,14 @@ components:
type: number
title: credit_line_total
description: The draft order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the draft order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
AdminDraftOrderListResponse:
type: object
description: The list of draft orders with pagination fields.
@@ -13718,6 +13728,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -13731,6 +13742,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -14335,6 +14347,14 @@ components:
type: number
title: credit_line_total
description: The draft order preview's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the draft order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
AdminDraftOrderPreviewResponse:
type: object
description: The details of the preview on the draft order.
@@ -15710,6 +15730,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -15723,6 +15744,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -15941,6 +15963,14 @@ components:
type: number
title: credit_line_total
description: The order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
AdminOrderAddress:
type: object
description: An order address.
@@ -16177,6 +16207,7 @@ components:
- return_id
- exchange_id
- claim_id
- ordering
- order_change_id
- reference
- reference_id
@@ -16263,6 +16294,10 @@ components:
format: date-time
title: updated_at
description: The date the action was updated.
ordering:
type: number
title: ordering
description: The action's order in the sequence of actions.
AdminOrderChangesResponse:
type: object
description: The details of an order's changes.
@@ -16668,6 +16703,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -16681,6 +16717,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -17285,6 +17322,14 @@ components:
type: number
title: credit_line_total
description: The order preview's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
AdminOrderPreviewResponse:
type: object
description: The preview of an order.
@@ -24153,6 +24198,14 @@ components:
type: number
title: timeout
description: The maximum time in seconds to wait for this step to complete. If the step exceeds this time, the step's state is changed to `timeout`, but the step continues executing.
autoRetry:
type: boolean
title: autoRetry
description: Whether the step should be automatically retried if it fails.
maxAwaitingRetries:
type: number
title: maxAwaitingRetries
description: The maximum number of times to retry the step while it's in the `waiting_response` state.
compensate:
type: object
description: The state of the step's compensation function.
@@ -25226,6 +25279,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -25239,6 +25293,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -25446,6 +25501,14 @@ components:
type: number
title: credit_line_total
description: The order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
BaseOrderAddress:
type: object
description: An order address.
@@ -28118,6 +28181,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -28133,6 +28197,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -28410,6 +28475,14 @@ components:
type: number
title: credit_line_total
description: The order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
OrderAddress:
type: object
description: The address's details.
@@ -31924,6 +31997,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -31937,6 +32011,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -32143,6 +32218,14 @@ components:
type: number
title: credit_line_total
description: The order's credit line total.
item_discount_total:
type: number
title: item_discount_total
description: The total discount amount applied on the order's items.
shipping_discount_total:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
StoreOrderAddress:
type: object
description: An order address