Medusa

List Shipping Options for Cart

GET

/store/shipping-options

Shipping Options

Retrieve a list of shipping options for a cart. The cart's ID is set in the required cart_id query parameter.

The shipping options also be sorted or paginated.

Request Example

JavaScript

Shell

Java

Swift

curl --location -g --request GET '{{BASE_URL}}/store/shipping-options?cart_id' \
--header 'x-publishable-api-key;'

Response Example

200 - Example 1

{
    "shipping_options": [
        {
            "id": "string",
            "name": "string",
            "service_zone_id": "string",
            "provider_id": "string",
            "shipping_profile_id": "string",
            "amount": 0,
            "insufficient_inventory": true,
            "price_type": "flat",
            "data": {},
            "provider": {
                "id": "string",
                "is_enabled": true
            },
            "type": {
                "id": "string",
                "label": "string",
                "description": "string",
                "code": "string"
            },
            "calculated_price": {
                "id": "string",
                "is_calculated_price_price_list": true,
                "calculated_amount": 0,
                "calculated_amount_with_tax": 0,
                "calculated_amount_without_tax": 0,
                "is_original_price_price_list": true,
                "original_amount": 0,
                "currency_code": "string",
                "original_amount_with_tax": 0,
                "original_amount_without_tax": 0,
                "is_calculated_price_tax_inclusive": true,
                "is_original_price_tax_inclusive": true,
                "calculated_price": {
                    "id": "string",
                    "price_list_id": "string",
                    "price_list_type": "string",
                    "min_quantity": 0,
                    "max_quantity": 0
                },
                "original_price": {
                    "id": "string",
                    "price_list_id": "string",
                    "price_list_type": "string",
                    "min_quantity": 0,
                    "max_quantity": 0
                }
            },
            "prices": [
                {
                    "id": "string",
                    "currency_code": "usd",
                    "amount": 0,
                    "min_quantity": 0,
                    "max_quantity": 0,
                    "price_rules": [
                        {
                            "id": "string",
                            "attribute": "string",
                            "value": "string",
                            "operator": "gt"
                        }
                    ]
                }
            ]
        }
    ]
}

Request

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

cart_id

string

cart_id

required

The ID of the cart to retrieve its shipping options.

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

is_return

boolean

is_return

optional

Whether the shipping option can be used for returns.

Header Params

x-publishable-api-key

string

required

Publishable API Key created in the Medusa Admin.

Responses

🟢200OK

application/json

Body

The shipping option's details.

shipping_options

array[object (StoreCartShippingOption) {13}]

required

The shipping option's shipping options.

string

required

The shipping option's ID.

name

string

name

required

The shipping option's name.

service_zone_id

string

service_zone_id

required

The ID of the service zone the shipping option belongs to.

provider_id

string

provider_id

required

The ID of the fulfillment provider handling this option.

shipping_profile_id

string

shipping_profile_id

required

The ID of the associated shipping profile.

amount

number

amount

required

The shipping option's amount.

insufficient_inventory

boolean

insufficient_inventory

required

Whether the shipping option's location doesn't have sufficient quantity for any of the cart's items.

price_type

enum<string>

required

The shipping option's price type. If it's flat, the price is fixed and is set in the prices property. If it's calculated, the price is calculated on checkout by the associated fulfillment provider.

Allowed values:

flatcalculated

data

object

required

The shipping option's data, useful for the provider handling fulfillment.

provider

object

required

The fulfillment provider's details.

type

object

required

The shipping option type's details.

calculated_price

object (StoreCalculatedPrice)

required

The shipping option's calculated price.

prices

array[object (StorePrice) {6}]

required

The shipping option's prices.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:21:30

Calculate Shipping Option Price