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.

The associated tax_lines.

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.