Skip to main content
GET
/
store
/
shipping-options
curl 'http://localhost:9000/store/shipping-options?cart_id=cart_01JB2KB1CD' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

{
  "shipping_options": {
    "sel_01JB2K8A1B": [
      {
        "id": "so_01JB2KC4GH",
        "name": "Standard Shipping",
        "price_type": "flat",
        "provider_id": "manual_manual",
        "amount": 900,
        "type": { "label": "Standard", "code": "standard" }
      }
    ],
    "sel_01JB2KF9ST": [
      {
        "id": "so_01JB2KG0UV",
        "name": "Express",
        "price_type": "flat",
        "provider_id": "manual_manual",
        "amount": 1500,
        "type": { "label": "Express", "code": "express" }
      }
    ]
  }
}
Returns the shipping options that can fulfill the given cart, grouped by the seller of the items each option applies to.

​
Query parameters

​
cart_id
string
required
ID of the cart to list shipping options for.
​
is_return
boolean
Set to true to list return shipping options.
​
fields
string
Comma-separated fields and relations to include on each shipping option; prefix with +/- to add to or remove from the defaults.

​
Response

​
shipping_options
object
Map of seller ID to the shipping options available for that seller’s items.
curl 'http://localhost:9000/store/shipping-options?cart_id=cart_01JB2KB1CD' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

{
  "shipping_options": {
    "sel_01JB2K8A1B": [
      {
        "id": "so_01JB2KC4GH",
        "name": "Standard Shipping",
        "price_type": "flat",
        "provider_id": "manual_manual",
        "amount": 900,
        "type": { "label": "Standard", "code": "standard" }
      }
    ],
    "sel_01JB2KF9ST": [
      {
        "id": "so_01JB2KG0UV",
        "name": "Express",
        "price_type": "flat",
        "provider_id": "manual_manual",
        "amount": 1500,
        "type": { "label": "Express", "code": "express" }
      }
    ]
  }
}