Menu

ShippingMethod - Cart Module Data Models Reference

This documentation provides a reference to the ShippingMethod data model. It belongs to the Cart Module.

idPrimaryKeyModifier<IdProperty>
The ID of the shipping method.
nameTextProperty
The name of the shipping method
amountBigNumberProperty
The amount of the shipping method
is_tax_inclusiveBooleanProperty
Whether the shipping method's amount is tax inclusive.
cartBelongsTo<Cart>
The associated cart.
tax_linesHasMany<ShippingMethodTaxLine>
The associated tax_lines.
adjustmentsHasMany<ShippingMethodAdjustment>
The associated adjustments.
descriptionJSONPropertyOptional
The description of the shipping method
shipping_option_idTextPropertyOptional
The ID of the related shipping option.
dataJSONPropertyOptional
The data of the shipping method, used by the associated fulfillment provider when processing the shipping method.
metadataJSONPropertyOptional
Holds custom data in key-value pairs.
Was this page helpful?
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
⇧↵