chore(docs): Updated API Reference (automated) (#10531)
* chore(docs): Generated API Reference (automated) * fixes --------- Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
16192d9b30
commit
a5ed061d6c
@@ -6,6 +6,9 @@ required:
|
||||
- email
|
||||
- accepted
|
||||
- token
|
||||
- expires_at
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
|
||||
@@ -4,6 +4,13 @@ x-schemaName: AdminShippingOptionPriceRule
|
||||
required:
|
||||
- id
|
||||
- value
|
||||
- operator
|
||||
- attribute
|
||||
- price_id
|
||||
- priority
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -13,3 +20,42 @@ properties:
|
||||
type: string
|
||||
title: value
|
||||
description: The price rule's value.
|
||||
operator:
|
||||
type: string
|
||||
description: The price rule's operator.
|
||||
enum:
|
||||
- gt
|
||||
- lt
|
||||
- eq
|
||||
- ne
|
||||
- in
|
||||
- lte
|
||||
- gte
|
||||
- nin
|
||||
attribute:
|
||||
type: string
|
||||
title: attribute
|
||||
description: The price rule's attribute.
|
||||
price_id:
|
||||
type: string
|
||||
title: price_id
|
||||
description: The ID of the price this rule applies to.
|
||||
priority:
|
||||
type: number
|
||||
title: priority
|
||||
description: The price rule's priority.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The date the price rule was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date the price rule was updated.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The date the price rule was deleted.
|
||||
|
||||
@@ -40,19 +40,8 @@ properties:
|
||||
title: no_notification
|
||||
description: Whether the customer should be notified about changes in the claim.
|
||||
refund_amount:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: refund_amount
|
||||
description: The claim's refund amount.
|
||||
- type: number
|
||||
title: refund_amount
|
||||
description: The claim's refund amount.
|
||||
- type: string
|
||||
title: refund_amount
|
||||
description: The claim's refund amount.
|
||||
- type: number
|
||||
title: refund_amount
|
||||
description: The claim's refund amount.
|
||||
type: number
|
||||
title: refund_amount
|
||||
description: The amount to be refunded.
|
||||
display_id:
|
||||
type: number
|
||||
|
||||
@@ -0,0 +1,122 @@
|
||||
type: object
|
||||
description: The shipping option's calculated price.
|
||||
x-schemaName: StoreCalculatedPrice
|
||||
required:
|
||||
- id
|
||||
- calculated_amount
|
||||
- original_amount
|
||||
- currency_code
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The ID of the price set from which the price was selected.
|
||||
is_calculated_price_price_list:
|
||||
type: boolean
|
||||
title: 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: Whether the calculated price is tax inclusive.
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/resources/commerce-modules/pricing/tax-inclusive-pricing
|
||||
calculated_amount:
|
||||
type: number
|
||||
title: 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_amount` with taxes applied.
|
||||
calculated_amount_without_tax:
|
||||
type: number
|
||||
title: calculated_amount_without_tax
|
||||
description: The `calculated_amount` without taxes applied.
|
||||
is_original_price_price_list:
|
||||
type: boolean
|
||||
title: 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: Whether the original price is tax inclusive.
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/resources/commerce-modules/pricing/tax-inclusive-pricing
|
||||
original_amount:
|
||||
type: number
|
||||
title: 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 currency code of the calculated price, or `null` if there isn't a
|
||||
calculated price.
|
||||
calculated_price:
|
||||
type: object
|
||||
description: The calculated price's details.
|
||||
required:
|
||||
- id
|
||||
- price_list_id
|
||||
- price_list_type
|
||||
- min_quantity
|
||||
- max_quantity
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The ID of the price.
|
||||
price_list_id:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The ID of the associated price list.
|
||||
price_list_type:
|
||||
type: string
|
||||
title: price_list_type
|
||||
description: The price list's type. For example, `sale` or `override`.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The minimum quantity required in the cart for the price to apply.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The maximum quantity required in the cart for the price to apply.
|
||||
original_price:
|
||||
type: object
|
||||
description: The origin price's details.
|
||||
required:
|
||||
- id
|
||||
- price_list_id
|
||||
- price_list_type
|
||||
- min_quantity
|
||||
- max_quantity
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The ID of the price.
|
||||
price_list_id:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The ID of the associated price list.
|
||||
price_list_type:
|
||||
type: string
|
||||
title: price_list_type
|
||||
description: The price list's type. For example, `sale` or `override`.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The minimum quantity required in the cart for the price to apply.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The maximum quantity required in the cart for the price to apply.
|
||||
@@ -12,6 +12,8 @@ required:
|
||||
- type
|
||||
- provider
|
||||
- amount
|
||||
- prices
|
||||
- calculated_price
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -92,3 +94,10 @@ properties:
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
prices:
|
||||
type: array
|
||||
description: The shipping option's prices.
|
||||
items:
|
||||
$ref: ./StorePrice.yaml
|
||||
calculated_price:
|
||||
$ref: ./StoreCalculatedPrice.yaml
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
type: object
|
||||
description: The price's details.
|
||||
x-schemaName: StorePrice
|
||||
required:
|
||||
- id
|
||||
- currency_code
|
||||
- amount
|
||||
- min_quantity
|
||||
- max_quantity
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The price's ID.
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The price's ISO 2 currency code.
|
||||
example: usd
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The price's amount.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The minimum quantity required in the cart for the price to apply.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The maximum quantity required in the cart for the price to apply.
|
||||
price_rules:
|
||||
type: array
|
||||
description: The price's rules.
|
||||
items:
|
||||
$ref: ./StorePriceRule.yaml
|
||||
@@ -0,0 +1,30 @@
|
||||
type: object
|
||||
description: The price rule's details.
|
||||
x-schemaName: StorePriceRule
|
||||
required:
|
||||
- id
|
||||
- attribute
|
||||
- operator
|
||||
- value
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The price rule's ID.
|
||||
attribute:
|
||||
type: string
|
||||
title: attribute
|
||||
description: The price rule's attribute.
|
||||
operator:
|
||||
type: string
|
||||
description: The price rule's operator.
|
||||
enum:
|
||||
- gt
|
||||
- lt
|
||||
- eq
|
||||
- lte
|
||||
- gte
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The price rule's value.
|
||||
Reference in New Issue
Block a user