658339767b
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
81 lines
2.3 KiB
YAML
81 lines
2.3 KiB
YAML
type: object
|
|
required:
|
|
- name
|
|
- region_id
|
|
- provider_id
|
|
- data
|
|
- price_type
|
|
properties:
|
|
name:
|
|
description: The name of the Shipping Option
|
|
type: string
|
|
region_id:
|
|
description: The ID of the Region in which the Shipping Option will be available.
|
|
type: string
|
|
provider_id:
|
|
description: The ID of the Fulfillment Provider that handles the Shipping Option.
|
|
type: string
|
|
profile_id:
|
|
description: The ID of the Shipping Profile to add the Shipping Option to.
|
|
type: number
|
|
data:
|
|
description: >-
|
|
The data needed for the Fulfillment Provider to handle shipping with this
|
|
Shipping Option.
|
|
type: object
|
|
price_type:
|
|
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. If the `price_type` is set
|
|
to `calculated`, this amount will not actually be used.
|
|
type: integer
|
|
requirements:
|
|
description: >-
|
|
The requirements that must be satisfied for the Shipping Option to be
|
|
available.
|
|
type: array
|
|
items:
|
|
type: object
|
|
required:
|
|
- type
|
|
- amount
|
|
properties:
|
|
type:
|
|
description: The type of the requirement
|
|
type: string
|
|
enum:
|
|
- max_subtotal
|
|
- min_subtotal
|
|
amount:
|
|
description: The amount to compare with.
|
|
type: integer
|
|
is_return:
|
|
description: Whether the Shipping Option can be used for returns or during checkout.
|
|
type: boolean
|
|
default: false
|
|
admin_only:
|
|
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: Tax included in prices of shipping option
|
|
x-featureFlag: tax_inclusive_pricing
|
|
type: boolean
|