asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/api/admin/components/schemas/ShippingOption.yaml
View File

@@ -1,6 +1,6 @@
title: Shipping Option
description: >-
Shipping Options represent a way in which an Order or Return can be shipped.
A Shipping Option represents a way in which an Order or Return can be shipped.
Shipping Options have an associated Fulfillment Provider that will be used
when the fulfillment of an Order is initiated. Shipping Options themselves
cannot be added to Carts, but serve as a template for Shipping Methods. This
@@ -34,32 +34,36 @@ properties:
type: string
example: PostFake Standard
region_id:
description: The region's ID
description: The ID of the region this shipping option can be used in.
type: string
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
region:
description: A region object. Available if the relation `region` is expanded.
description: The details of the region this shipping option can be used in.
x-expandable: region
nullable: true
type: object
profile_id:
description: >-
The ID of the Shipping Profile that the shipping option belongs to.
Shipping Profiles have a set of defined Shipping Options that can be used
to Fulfill a given set of Products.
description: The ID of the Shipping Profile that the shipping option belongs to.
type: string
example: sp_01G1G5V239ENSZ5MV4JAR737BM
profile:
description: Available if the relation `profile` is expanded.
description: The details of the shipping profile that the shipping option belongs to.
x-expandable: profile
nullable: true
$ref: ./ShippingProfile.yaml
provider_id:
description: >-
The id of the Fulfillment Provider, that will be used to process
Fulfillments from the Shipping Option.
The ID of the fulfillment provider that will be used to later to process
the shipping method created from this shipping option and its
fulfillments.
type: string
example: manual
provider:
description: Available if the relation `provider` is expanded.
description: >-
The details of the fulfillment provider that will be used to later to
process the shipping method created from this shipping option and its
fulfillments.
x-expandable: provider
nullable: true
$ref: ./FulfillmentProvider.yaml
price_type:
@@ -91,10 +95,10 @@ properties:
default: false
requirements:
description: >-
The requirements that must be satisfied for the Shipping Option to be
available for a Cart. Available if the relation `requirements` is
expanded.
The details of the requirements that must be satisfied for the Shipping
Option to be available for usage in a Cart.
type: array
x-expandable: requirements
items:
$ref: ./ShippingOptionRequirement.yaml
data:
@@ -104,8 +108,9 @@ properties:
type: object
example: {}
includes_tax:
description: '[EXPERIMENTAL] Does the shipping option price include tax'
description: Whether the shipping option price include tax
type: boolean
x-featureFlag: tax_inclusive_pricing
default: false
created_at:
description: The date with timezone at which the resource was created.
@@ -126,3 +131,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute