Sign in

v1

latestOpenAPI 3.0.02026-07-14455376855.8 KB
carts/{cartId}/shipping-methods

carts/{cartId}/shipping-methods

Lists applicable shipping methods for a specified quote.

get/V1/carts/{cartId}/shipping-methods

Path parameters

cartIdinteger required

The shopping cart ID.

Response

200 Success.

amountnumber required

Shipping amount in store currency.

availableboolean required

The value of the availability flag for the current shipping method.

base_amountnumber required

Shipping amount in base currency.

carrier_codestring required

Shipping carrier code.

carrier_titlestring

Shipping carrier title. Otherwise, null.

error_messagestring required

Shipping Error message.

extension_attributesQuoteDataShippingMethodExtensionInterface

ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface

method_codestring required

Shipping method code.

method_titlestring

Shipping method title. Otherwise, null.

price_excl_taxnumber required

Shipping price excl tax.

price_incl_taxnumber required

Shipping price incl tax.