Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Shipping Options
  • Introduction
  • Authentication
  • HTTP Compression
  • Publishable API Key
  • Expanding Fields
  • Selecting Fields
  • Query Parameter Types
  • Pagination
  • Currencies
    • List Currencies
      GET
    • Get a Currency
      GET
  • Payment Providers
    • List Payment Providers
      GET
  • Return Reasons
    • List Return Reasons
      GET
    • Get a Return Reason
      GET
  • Auth
    • Retrieve Registration JWT Token
      POST
    • Authenticate Customer
      POST
    • Generate Reset Password Token for Customer
      POST
    • Refresh Authentication Token
      POST
    • Validate Authentication Callback
      POST
    • Delete Authentication Session
      DELETE
    • Set Authentication Session
      POST
    • Reset a Customer's Password
      POST
  • Collections
    • List Collections
      GET
    • Get a Collection
      GET
  • Regions
    • List Regions
    • Get a Region
  • Products
    • List Products
    • Get a Product
  • Customers
    • Get Logged-in Customer
    • Update Customer
    • Create Address for Logged-In Customer
    • List Customer's Addresses
    • Get Customer's Address
    • Update Customer's Address
    • Remove Customer's Address
    • Register Customer
  • Product Tags
    • List Product Tags
    • Get a Product Tag
  • Returns
    • Create Return
  • Product Types
    • Get a Product Type
    • List Product Types
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Carts
    • Create Cart
    • Set Cart's Customer
    • Add Shipping Method to Cart
    • Add Line Item to Cart
    • Calculate Cart Taxes
    • Get a Cart
    • Update a Cart
    • Update a Line Item in a Cart
    • Remove Line Item from Cart
    • Complete Cart
    • Add Promotions to Cart
    • Remove Promotions from Cart
  • Orders
    • List Logged-in Customer's Orders
    • Request Order Transfer
    • Get an Order
    • Cancel Order Transfer
    • Decline Order Transfer
    • Accept Order Transfer
  • Payment Collections
    • Initialize Payment Session of a Payment Collection
    • Create Payment Collection
  • Shipping Options
    • Calculate Shipping Option Price
      POST
    • List Shipping Options for Cart
      GET
  1. Shipping Options

Calculate Shipping Option Price

POST
/store/shipping-options/{id}/calculate
Calculate the price of a shipping option in a cart.
Request Request Example
JavaScript
Shell
Java
Swift
curl --location -g --request POST '{{BASE_URL}}/store/shipping-options//calculate' \
--header 'x-publishable-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cart_id": "string",
    "data": {}
}'
Response Response Example
200 - Example 1
{
    "shipping_option": {
        "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

Path Params

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
OK
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Modified at 2025-06-17 04:21:30
Previous
Create Payment Collection
Next
List Shipping Options for Cart
Built with