Calculate Shipping Option Price

POST

/store/shipping-options/{id}/calculate

Calculate the price of a shipping option in a cart.

Request Example

Shell

JavaScript

Java

Swift

curl -X POST '{backend_url}/store/shipping-options/{id}/calculate' \
-H 'x-publishable-api-key: {your_publishable_api_key}' \
-H 'Content-Type: application/json' \
--data-raw '{
  "cart_id": "{value}"
}'

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

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

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

Create Payment Collection

List Shipping Options for Cart