Skip to main content
POST
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

Body

application/json
name
string
required
Example:

"Oversized"

kind
string

Registered profile kind (shipping, digital, extension kinds) from the kinds endpoint. Read on create only; defaults to shipping.

Example:

"shipping"

default
boolean

Promotes this profile to the store default; the previous default is demoted.

position
integer
stock_location_ids
string[]

Prefixed stock location IDs (sloc_...); replaces the full set. Empty means every store location.

Response

delivery profile created