Get Started
Product
Framework
Commerce Modules
Infrastructure Modules
Build
Recipes
How-to & Tutorials
Integrations
Storefront
Tools
CLI Tools
JS SDK
Next.js Starter
Medusa UI
Reference
Admin API
Store API
Admin Injection Zones
Container Resources
Core Workflows
Data Model Language
Data Model Repository
Events Reference
Helper Steps
Service Factory
Testing Framework
Workflows SDK
User Guide
Cloud
v2.10.3
Help
Troubleshooting
Report Issue
Discord Community
Contact Sales
Ask AI
Homepage
Medusa v1
Changelog
Hide Sidebar
⌘\
Theme
Light
Dark
Menu
Get Started
Product
Build
Tools
Reference
User Guide
Cloud
Documentation
Loading...
Was this page helpful?
It was helpful
It wasn't helpful
Report Issue
New version
v2.10.3 details
Loading...
View as Markdown
Explain with AI Assistant
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧
↵
Navigation
↑
↓
Open Result
↵
AdminCreateShippingOption
Properties
#
name
string
The name of the shipping option. Customers can view this name during checkout.
service_zone_id
string
The ID of the service zone that the shipping option belongs to. Learn more in the
Shipping Options
documentation.
shipping_profile_id
string
The ID of the shipping profile that the shipping option belongs to. Learn more in the
Shipping Options
documentation.
price_type
ShippingOptionPriceType
The type of shipping option's price.
provider_id
string
The ID of the fulfillment provider that the shipping option belongs to.
prices
(
AdminCreateShippingOptionPriceWithCurrency
|
AdminCreateShippingOptionPriceWithRegion
)[]
The prices of the shipping option.
data
Record<string, unknown>
Optional
Additional data that is useful for third-party fulfillment providers that process fulfillments for the shipping option. Learn more in the
Shipping Options
documentation.
type
AdminCreateShippingOptionType
Optional
The type of shipping option. Learn more in the
Shipping Option
documentation.
type_id
string
Optional
The ID of the type of shipping option. Learn more in the
Shipping Option
documentation.
rules
AdminCreateShippingOptionRule
[]
Optional
The rules of the shipping option. Learn more in the
Shipping Option Rules
documentation.