• Overview
  • Examples
  • Recipes
  • Commerce Modules
  • Architectural Modules
  • Integrations
  • Storefront Development
    • SDKs and Tools
    • create-medusa-app
    • Medusa CLI
    • JS SDK
    • Next.js Starter Storefront
    General
    • Medusa Configurations
    • Deployment Guides
    • Troubleshooting Guides
    Admin
    • Admin Widget Injection Zones
    • Admin Components
    Lists
    • Container Dependencies
    • Events List
    References
    • Workflows SDK
    • Data Model Language
    • Service Factory
    • Helper Steps
    • Core Workflows
    • Testing Framework
    Other
    • Contribution Guidelines
      • Docs
      • Admin Translations
    • Usage
  • Get Started
  • Product
    Commerce Modules
    Architectural Modules
  • Resources
    Guides
    Examples
    Recipes
    Admin Components
    Storefront Development
    UI Library
  • Tools & SDKs
    Medusa CLI
    JS SDK
    Next.js Starter
    create-medusa-app
    Integrations
  • Framework
    Modules
    API Routes
    Workflows
    Data Models
    Subscribers
    Scheduled Jobs
    Loaders
    Admin Customizations
    Links
    Query
  • Reference
    Admin API
    Store API
    Core Workflows
    Data Model Language
    Service Factory
    Events Reference
    Admin Widget Injection Zones
v2.3·Report Issue
Homepage
Medusa v1
Changelog
Troubleshooting
Hide Sidebar⌘\
Theme
Light
Dark
Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

ShippingOptionDTO

The shipping option details.

Loading...
Was this page helpful?
Edit this page
      Guides
      • All Areas
      • Guides
      • References
      • Admin API (v2)
      • Store API (v2)
      • Medusa UI
      Navigation↑↓
      Open Result↵
      idstring
      The ID of the shipping option.
      namestring
      The name of the shipping option.
      price_typeShippingOptionPriceType
      The type of the shipping option's price.
      service_zone_idstring
      The associated service zone's ID.
      shipping_profile_idstring
      The associated shipping profile's ID.
      provider_idstring
      The associated fulfillment provider's ID.
      shipping_option_type_idnull | string
      The associated shipping option type's ID.
      datanull | Record<string, unknown>
      The data necessary for the associated fulfillment provider to process the shipping option and, later, its associated fulfillments.
      metadatanull | Record<string, unknown>
      Holds custom data in key-value pairs.
      service_zoneServiceZoneDTO
      The associated service zone.
      shipping_profileShippingProfileDTO
      The associated shipping profile.
      fulfillment_providerFulfillmentProviderDTO
      The associated fulfillment provider.
      typeShippingOptionTypeDTO
      The associated shipping option type.
      rulesShippingOptionRuleDTO[]
      The rules associated with the shipping option.
      fulfillmentsFulfillmentDTO[]
      The fulfillments associated with the shipping option.
      created_atDate
      The creation date of the shipping option.
      updated_atDate
      The update date of the shipping option.
      deleted_atnull | Date
      The deletion date of the shipping option.