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

Bearer token for admin authentication

Path Parameters

id
string
required

Package type ID

Body

application/json
name
string

Unique within the store.

Example:

"Euro pallet"

kind
enum<string>

What this packaging is: the box parcels ship in, or the carton, pallet or container a wholesale order leaves on.

Available options:
box,
envelope,
carton,
pallet,
container
Example:

"pallet"

length
number | null
width
number | null
height
number | null
dimensions_unit
enum<string> | null

Unit the three dimensions are in; falls back to the store's unit system.

Available options:
mm,
cm,
in,
ft
Example:

"cm"

weight
number | null

The empty package's own weight, added to content weight on every quote.

max_weight
number | null

What the package can hold, not the same as its own weight.

weight_unit
enum<string> | null
Available options:
g,
kg,
lb,
oz
Example:

"kg"

default
boolean

The box every parcel quote is built on. Setting this demotes whichever row held it.

metadata
object

Response

200 - application/json

package type updated

id
string
required
name
string
required
kind
enum<string>
required
Available options:
box,
envelope,
carton,
pallet,
container
length
string | null
required
width
string | null
required
height
string | null
required
weight
string | null
required
max_weight
string | null
required
default
boolean
required
metadata
object | null
required
created_at
string
required
updated_at
string
required
dimensions_unit
enum<string>
required
Available options:
mm,
cm,
in,
ft
weight_unit
enum<string>
required
Available options:
g,
kg,
lb,
oz
volume
string | null
required
seller_id
string | null
required
seller_name
string | null
required