Storefront APICart
Simulate freight for products
Quotes freight for a set of variants without touching a cart, for the product page's "calculate shipping" box. Nothing is saved.
Path Parameters
store_slug*string
Store slug
Header Parameters
Idempotency-Key?string
A unique value (e.g. a UUID) per logical request. Retrying with the same key within 24 hours replays the first response instead of repeating the side effect; the replay carries Idempotent-Replayed: true. Reusing a key for a different request is a 422 idempotency_key_reused; retrying while the first is still running is a 409 idempotency_request_in_progress. JSON bodies up to 1 MB.
Length
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/storefront-api/string/api/freight/simulate" \ -H "Content-Type: application/json" \ -d '{ "destination_postal_code": "string", "items": [ { "quantity": 0, "variant_id": "string" } ] }'{
"destination_postal_code": "string",
"expires_at": "2019-08-24T14:15:22Z",
"options": [
{
"carrier_name": "string",
"delivery_days": 0,
"option_id": "string",
"provider_code": "string",
"quotation_code": "string",
"raw": {},
"service_name": "string",
"shipping_cents": 0
}
],
"provider_code": "string",
"quotation_code": "string",
"simulated_item_count": 0,
"simulated_subtotal_cents": 0
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}