api-ref: custom API reference (#4770)
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,137 @@
|
||||
title: Shipping Option
|
||||
description: >-
|
||||
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
|
||||
distinction makes it possible to customize individual Shipping Methods with
|
||||
additional information.
|
||||
type: object
|
||||
required:
|
||||
- admin_only
|
||||
- amount
|
||||
- created_at
|
||||
- data
|
||||
- deleted_at
|
||||
- id
|
||||
- is_return
|
||||
- metadata
|
||||
- name
|
||||
- price_type
|
||||
- profile_id
|
||||
- provider_id
|
||||
- region_id
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
description: The shipping option's ID
|
||||
type: string
|
||||
example: so_01G1G5V27GYX4QXNARRQCW1N8T
|
||||
name:
|
||||
description: >-
|
||||
The name given to the Shipping Option - this may be displayed to the
|
||||
Customer.
|
||||
type: string
|
||||
example: PostFake Standard
|
||||
region_id:
|
||||
description: The ID of the region this shipping option can be used in.
|
||||
type: string
|
||||
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
|
||||
region:
|
||||
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.
|
||||
type: string
|
||||
example: sp_01G1G5V239ENSZ5MV4JAR737BM
|
||||
profile:
|
||||
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 later to process
|
||||
the shipping method created from this shipping option and its
|
||||
fulfillments.
|
||||
type: string
|
||||
example: manual
|
||||
provider:
|
||||
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:
|
||||
description: >-
|
||||
The type of pricing calculation that is used when creatin Shipping Methods
|
||||
from the Shipping Option. Can be `flat_rate` for fixed prices or
|
||||
`calculated` if the Fulfillment Provider can provide price calulations.
|
||||
type: string
|
||||
enum:
|
||||
- flat_rate
|
||||
- calculated
|
||||
example: flat_rate
|
||||
amount:
|
||||
description: >-
|
||||
The amount to charge for shipping when the Shipping Option price type is
|
||||
`flat_rate`.
|
||||
nullable: true
|
||||
type: integer
|
||||
example: 200
|
||||
is_return:
|
||||
description: Flag to indicate if the Shipping Option can be used for Return shipments.
|
||||
type: boolean
|
||||
default: false
|
||||
admin_only:
|
||||
description: >-
|
||||
Flag to indicate if the Shipping Option usage is restricted to admin
|
||||
users.
|
||||
type: boolean
|
||||
default: false
|
||||
requirements:
|
||||
description: >-
|
||||
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:
|
||||
description: >-
|
||||
The data needed for the Fulfillment Provider to identify the Shipping
|
||||
Option.
|
||||
type: object
|
||||
example: {}
|
||||
includes_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.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
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
|
||||
Reference in New Issue
Block a user