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>
This commit is contained in:
github-actions[bot]
2024-10-03 07:48:54 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 97c193be1b
commit 21badd069d
894 changed files with 35649 additions and 28168 deletions
@@ -1,5 +1,5 @@
type: object
description: The order's summary.
description: The order's summary details.
x-schemaName: BaseOrderSummary
required:
- total
@@ -10,71 +10,46 @@ required:
- returned_total
- return_request_total
- write_off_total
- projected_total
- net_total
- net_subtotal
- net_total_tax
- balance
- paid_total
- refunded_total
properties:
total:
type: number
title: total
description: The summary's total.
description: The order's total including taxes and promotions.
subtotal:
type: number
title: subtotal
description: The summary's subtotal.
description: The order's total excluding taxes, including promotions.
total_tax:
type: number
title: total_tax
description: The summary's total tax.
description: The order's total taxes.
ordered_total:
type: number
title: ordered_total
description: The summary's ordered total.
description: The order's total when it was placed.
fulfilled_total:
type: number
title: fulfilled_total
description: The summary's fulfilled total.
description: The total of the fulfilled items of the order.
returned_total:
type: number
title: returned_total
description: The summary's returned total.
description: The total of the order's returned items.
return_request_total:
type: number
title: return_request_total
description: The summary's return request total.
description: The total of the items requested to be returned.
write_off_total:
type: number
title: write_off_total
description: The summary's write off total.
projected_total:
type: number
title: projected_total
description: The summary's projected total.
net_total:
type: number
title: net_total
description: The summary's net total.
net_subtotal:
type: number
title: net_subtotal
description: The summary's net subtotal.
net_total_tax:
type: number
title: net_total_tax
description: The summary's net total tax.
balance:
type: number
title: balance
description: The summary's balance.
description: The total of the items removed from the order.
paid_total:
type: number
title: paid_total
description: The summary's paid total.
description: The total amount paid.
refunded_total:
type: number
title: refunded_total
description: The summary's refunded total.
description: The total amount refunded.