Skip to main content
PATCH
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Path Parameters

id
string
required

Body

application/json
name
string
Example:

"Express"

admin_name
string | null
code
string | null
fulfillment_provider
string

Fulfillment provider shorthand (see the fulfillment providers endpoint), e.g. manual.

Example:

"manual"

pickup_point_provider
string | null
rate_provider
string | null

Rate provider shorthand (see the rate providers endpoint), e.g. easy_post. Omit or send null for the built-in provider, which prices through the method's calculator.

storefront_visible
boolean
available_to_sellers
boolean

Marketplace only: whether a seller's packages may be quoted by this method. Off by default, and refused on a method that belongs to a seller.

tracking_url
string | null
estimated_transit_business_days_min
integer | null
estimated_transit_business_days_max
integer | null
tax_category_id
string | null

Prefixed tax category ID (taxcat_...), or null to clear.

markup_flat
string<decimal> | null

Method-level flat handling fee added on top of provider-quoted rates.

Pattern: ^-?\d+(\.\d+)?$
markup_percent
string<decimal> | null

Method-level percentage handling fee added on top of provider-quoted rates. Ignored for calculator-priced methods.

Pattern: ^-?\d+(\.\d+)?$
delivery_profile_id
string

Delivery profile this method belongs to (fp_...); defaults to the store default profile.

Example:

"fp_86Rf07xd4z"

delivery_origin_group_id
string

Origin group offering this method (og_...); defaults to the zone's group, else the profile's default group.

delivery_zone_id
string | null

Delivery zone narrowing destinations (dz_...), or null for no restriction. Must belong to the method's profile.

stock_location_ids
string[]

Pickup locations (sloc_...); replaces the full set.

calculator
object

How the method prices a shipment: a type from the calculators endpoint and its preferences, matching that type's schema.

rules
object[]

Eligibility rules. Replaces the full set: omitted rules are removed.

services
object[]

Carrier service rows: which provider services this method offers. Replaces the full set: omitted rows are removed; no rows means every service the provider returns is offered.

Response

200 - application/json

delivery method updated