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:
committed by
GitHub
parent
efdea04963
commit
658339767b
@@ -6,14 +6,22 @@ properties:
|
||||
description: The name of the Shipping Option
|
||||
type: string
|
||||
amount:
|
||||
description: The amount to charge for the Shipping Option.
|
||||
description: >-
|
||||
The amount to charge for the Shipping Option. If the `price_type` of the
|
||||
shipping option is `calculated`, this amount will not actually be used.
|
||||
type: integer
|
||||
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
|
||||
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
|
||||
requirements:
|
||||
description: >-
|
||||
The requirements that must be satisfied for the Shipping Option to be
|
||||
@@ -26,7 +34,10 @@ properties:
|
||||
- amount
|
||||
properties:
|
||||
id:
|
||||
description: The ID of the requirement
|
||||
description: >-
|
||||
The ID of an existing requirement. If an ID is passed, the existing
|
||||
requirement's details are updated. Otherwise, a new requirement is
|
||||
created.
|
||||
type: string
|
||||
type:
|
||||
description: The type of the requirement
|
||||
@@ -38,5 +49,6 @@ properties:
|
||||
description: The amount to compare with.
|
||||
type: integer
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user