Sign in

v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB
Ecommerce: Shipping

Set store shipping

Set the flat-rate shipping price for a store, creating the shipping zone if it does not exist yet.

post/api/ecommerce/v1/stores/{store_id}/shipping

Path parameters

store_idstring required
Example:store_01J8Z5F8W9K8M4A7B3C2D1E0FG

The ID of the store to configure shipping for.

Request body

priceinteger required

Flat shipping rate in the smallest currency unit (e.g. cents). Use 0 for free shipping.

Example request

{
  "price": 500
}

Response

Success response

admin_urlstring

Admin UI deep-link to manage shipping settings.

Example response

{
  "shipping_option": {
    "id": "so_01J8Z5F8W9K8M4A7B3C2D1E0FG",
    "amount": 500,
    "currency_code": "usd"
  },
  "admin_url": "https://admin.example.com/store_01.../store-settings/shipping"
}