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
parent 97c193be1b
commit 21badd069d
894 changed files with 35649 additions and 28168 deletions

View File

@@ -1,5 +1,5 @@
type: object
description: The parent's calculated price.
description: The calculated price's details.
x-schemaName: BaseCalculatedPriceSet
required:
- id
@@ -14,42 +14,102 @@ properties:
is_calculated_price_price_list:
type: boolean
title: is_calculated_price_price_list
description: The calculated price's is calculated price price list.
description: Whether the calculated price belongs to a price list.
is_calculated_price_tax_inclusive:
type: boolean
title: is_calculated_price_tax_inclusive
description: The calculated price's is calculated price tax inclusive.
description: Whether the calculated price is tax inclusive.
calculated_amount:
type: number
title: calculated_amount
description: The calculated price's calculated amount.
description: >-
The amount of the calculated price, or `null` if there isn't a calculated
price. This is the amount shown to the customer.
calculated_amount_with_tax:
type: number
title: calculated_amount_with_tax
description: The calculated price's calculated amount with tax.
description: The calculated price's amount with taxes applied.
calculated_amount_without_tax:
type: number
title: calculated_amount_without_tax
description: The calculated price's calculated amount without tax.
description: The calculated price's amount without taxes applied.
is_original_price_price_list:
type: boolean
title: is_original_price_price_list
description: The calculated price's is original price price list.
description: Whether the original price belongs to a price list.
is_original_price_tax_inclusive:
type: boolean
title: is_original_price_tax_inclusive
description: The calculated price's is original price tax inclusive.
description: Whether the original price is tax inclusive.
original_amount:
type: number
title: original_amount
description: The calculated price's original amount.
description: >-
The amount of the original price, or `null` if there isn't an original
price. This amount is useful to compare with the `calculated_amount`, such
as to check for discounted value.
currency_code:
type: string
title: currency_code
description: The calculated price's currency code.
example: usd
calculated_price:
type: object
description: The calculated price's details.
properties:
id:
type: string
title: id
description: The calculated price's ID.
price_list_id:
type: string
title: price_list_id
description: The ID of the price list that the price belongs to.
price_list_type:
type: string
title: price_list_type
description: The price list's type. For example, `sale`.
min_quantity:
type: number
title: min_quantity
description: The minimum quantity required in the cart for this price to apply.
max_quantity:
type: number
title: max_quantity
description: The maximum quantity required in the cart for this price to apply.
required:
- id
- price_list_id
- price_list_type
- min_quantity
- max_quantity
original_price:
type: object
description: The calculated price's original price.
description: The original price's details.
properties:
id:
type: string
title: id
description: The original price's ID.
price_list_id:
type: string
title: price_list_id
description: The ID of the price list that the price belongs to.
price_list_type:
type: string
title: price_list_type
description: The price list's type. For example, `sale`.
min_quantity:
type: number
title: min_quantity
description: The minimum quantity required in the cart for this price to apply.
max_quantity:
type: number
title: max_quantity
description: The maximum quantity required in the cart for this price to apply.
required:
- id
- price_list_id
- price_list_type
- min_quantity
- max_quantity