Skip to main content
POST
Create a delivery method

Authorizations

Authorization
string
header
required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id
string
required

Body

application/json
name
string
required
admin_name
string | null
code
string | null
delivery_profile_id
string

One of the marketplace's delivery profiles

delivery_zone_id
string | null

Narrows where the method ships

storefront_visible
boolean
tracking_url
string | null
estimated_transit_business_days_min
integer | null
estimated_transit_business_days_max
integer | null
calculator_type
string
calculator_preferences
object
rules
object[]

Conditions on the method, from /delivery_methods/rule_types

Response

delivery method created

id
string
required
name
string
required
code
string | null
required
estimated_transit_business_days_min
number | null
required
estimated_transit_business_days_max
number | null
required
digital
boolean
required
pickup
boolean
required
pickup_point
boolean
required
admin_name
string | null
required
storefront_visible
boolean
required
tracking_url
string | null
required
created_at
string
required
updated_at
string
required
rules
object[]
required
editable
boolean
required
delivery_profile_id
string | null
required
delivery_zone_id
string | null
required
calculator_type
string | null
required
calculator_preferences
object | null
required