chore(docs): Generated API Reference (#4706)

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]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions

View File

@@ -24,13 +24,18 @@ properties:
Shipping Option.
type: object
price_type:
description: The type of the Shipping Option price.
description: >-
The type of the Shipping Option price. `flat_rate` indicates fixed
pricing, whereas `calculated` indicates that the price will be calculated
each time by the fulfillment provider.
type: string
enum:
- flat_rate
- calculated
amount:
description: The amount to charge for the Shipping Option.
description: >-
The amount to charge for the Shipping Option. If the `price_type` is set
to `calculated`, this amount will not actually be used.
type: integer
requirements:
description: >-
@@ -53,16 +58,23 @@ properties:
description: The amount to compare with.
type: integer
is_return:
description: Whether the Shipping Option defines a return shipment.
description: Whether the Shipping Option can be used for returns or during checkout.
type: boolean
default: false
admin_only:
description: If true, the option can be used for draft orders
description: >-
If set to `true`, the shipping option can only be used when creating draft
orders.
type: boolean
default: false
metadata:
description: An optional set of key-value pairs with additional information.
type: object
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
includes_tax:
description: '[EXPERIMENTAL] Tax included in prices of shipping option'
description: Tax included in prices of shipping option
x-featureFlag: tax_inclusive_pricing
type: boolean