Skip to main content
POST
Create manual shipping method

Authorizations

Authorization
string
header
required

Sign in to the admin dashboard and use the resulting ID token for a store and operation you can access. The authenticated dashboard cookie is accepted when the Authorization header is absent. Missing or insufficient access returns 401.

Body

application/json
name
string
required
Maximum string length: 64
shipping_method_type
enum<string>
required
Available options:
manual,
local-pickup
is_default
boolean
default:false
required
is_forward_shipping
boolean
default:true
required
is_return_shipping
boolean
default:true
required
enable_shipping_rate
boolean
required
delivery_leadtime_minimum
integer
required

in days.

delivery_leadtime_maximum
integer
required

in days.

shipping_zone_id
string[]
required
write-only
warehouse_id
string[]
required
write-only
fulfillment_type
enum<string>
required
Available options:
delivery,
collect-in-store
maximum_weight
number | null

can be null if there is no limit on weight.

shipping_rate_name
string | null

required if enable_shipping_rate = true; null when no shipping rate is set.

shipping_rate_fixed_price
number | null

can be null if shipping_rate_condition is provided.

shipping_rate_condition
ShippingRateBasedOnWeightSlabs · object
status
enum<string>
Available options:
active,
inactive
description
string | null
Maximum string length: 512

Response

OK

message
string
required
success
boolean
required
content
object
required