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

10
www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml
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.

10
www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml
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.

10
www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml
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.

5
www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeAction.yaml
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.

10
www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml
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.

10
www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml
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.

10
www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml
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.

10
www/apps/api-reference/specs/admin/components/schemas/Order.yaml
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.

10
www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml
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.

212
www/apps/api-reference/specs/admin/openapi.full.yaml
View File

@@ -36259,6 +36259,135 @@ paths:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
- name: id
in: query
required: false
description: Filter by a promotion's ID.
schema:
oneOf:
- type: string
title: id
description: Filter by a promotion's ID.
- type: array
description: Filter by promotion IDs.
items:
type: string
title: id
description: The promotion's ID.
- type: object
description: Filter by a promotion's ID.
properties:
$and:
type: array
description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching the conditions in this parameter.
- type: object
description: Filter by values not matching the conditions in this parameter.
- type: array
description: Filter by values not matching the conditions in this parameter.
items:
type: string
title: $not
description: Filter by values not matching the conditions in this parameter.
$gt:
type: string
title: $gt
description: Filter by values greater than this parameter. Useful for numbers and dates only.
$gte:
type: string
title: $gte
description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: Filter by values less than this parameter. Useful for numbers and dates only.
$lte:
type: string
title: $lte
description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
security:
- api_token: []
- cookie_auth: []
@@ -59055,6 +59184,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -59068,6 +59198,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -59287,6 +59418,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.
@@ -59346,6 +59485,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -59359,6 +59499,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -59963,6 +60104,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.
@@ -61338,6 +61487,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -61351,6 +61501,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -61569,6 +61720,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.
@@ -61805,6 +61964,7 @@ components:
- return_id
- exchange_id
- claim_id
- ordering
- order_change_id
- reference
- reference_id
@@ -61891,6 +62051,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.
@@ -62296,6 +62460,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -62309,6 +62474,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -62913,6 +63079,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.
@@ -69781,6 +69955,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.
@@ -70854,6 +71036,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -70867,6 +71050,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -71074,6 +71258,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.
@@ -73746,6 +73938,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -73761,6 +73954,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -74038,6 +74232,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.
@@ -77552,6 +77754,7 @@ components:
- item_total
- item_subtotal
- item_tax_total
- item_discount_total
- original_total
- original_subtotal
- original_tax_total
@@ -77565,6 +77768,7 @@ components:
- shipping_total
- shipping_subtotal
- shipping_tax_total
- shipping_discount_total
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
@@ -77771,6 +77975,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

161
www/apps/api-reference/specs/admin/paths/admin_promotions.yaml
View File

@@ -599,6 +599,167 @@ get:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
- name: id
in: query
required: false
description: Filter by a promotion's ID.
schema:
oneOf:
- type: string
title: id
description: Filter by a promotion's ID.
- type: array
description: Filter by promotion IDs.
items:
type: string
title: id
description: The promotion's ID.
- type: object
description: Filter by a promotion's ID.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
security:
- api_token: []
- cookie_auth: []

10
www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml
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.

10
www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml
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.

10
www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml
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.

5
www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml
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.

10
www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml
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.

10
www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml
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.

10
www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml
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.

10
www/apps/api-reference/specs/store/components/schemas/Order.yaml
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.

10
www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml
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.

83
www/apps/api-reference/specs/store/openapi.full.yaml
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