Calculate Shipping Option

POST/store/:storeCode/shipping-options/:id/calculate

publishable key

Calculate a shipping option price for a cart.

Path Parameters

storeCoderequiredstring

Store slug in the URL (first argument to every SDK store method).

idrequiredstring

Shipping option ID.

Query Parameters

fieldsstring

Comma-separated fields to include. Prefix with `*` to expand a relation (e.g. `id,*variants`).

Request Body

Schema

Copy

HttpTypes.StoreCalculateShippingOptionPrice

Properties

cart_idrequiredstring

Cart used for price calculation.

dataRecord<string, unknown>

Provider-specific calculation data.

Response

Status

200OK

Schema

Copy

HttpTypes.StoreShippingOptionResponse

Properties

shipping_optionrequiredStoreCartShippingOption

Shipping option with calculated amount.