Files
medusa-store/www/apps/api-reference/specs/admin/components/schemas/BaseOrderSummary.yaml
github-actions[bot] 21badd069d chore(docs): Updated API Reference (v2) (#9437)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-03 07:48:54 +00:00

56 lines
1.4 KiB
YAML

type: object
description: The order's summary details.
x-schemaName: BaseOrderSummary
required:
- total
- subtotal
- total_tax
- ordered_total
- fulfilled_total
- returned_total
- return_request_total
- write_off_total
- paid_total
- refunded_total
properties:
total:
type: number
title: total
description: The order's total including taxes and promotions.
subtotal:
type: number
title: subtotal
description: The order's total excluding taxes, including promotions.
total_tax:
type: number
title: total_tax
description: The order's total taxes.
ordered_total:
type: number
title: ordered_total
description: The order's total when it was placed.
fulfilled_total:
type: number
title: fulfilled_total
description: The total of the fulfilled items of the order.
returned_total:
type: number
title: returned_total
description: The total of the order's returned items.
return_request_total:
type: number
title: return_request_total
description: The total of the items requested to be returned.
write_off_total:
type: number
title: write_off_total
description: The total of the items removed from the order.
paid_total:
type: number
title: paid_total
description: The total amount paid.
refunded_total:
type: number
title: refunded_total
description: The total amount refunded.