Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

const { data: packageTypes } = await client.packageTypes.list({ owner: 'mine' })

{
  "data": [
    {
      "id": "pkgtype_UkLWZg9DAJ",
      "name": "Standard mailer",
      "kind": "box",
      "length": "30.0",
      "width": "20.0",
      "height": "15.0",
      "weight": "0.4",
      "max_weight": null,
      "default": true,
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "dimensions_unit": "cm",
      "weight_unit": "kg",
      "volume": "0.009",
      "editable": true
    },
    {
      "id": "pkgtype_gbHJdmfrXB",
      "name": "Marketplace carton",
      "kind": "carton",
      "length": "40.0",
      "width": "30.0",
      "height": "25.0",
      "weight": null,
      "max_weight": "20.0",
      "default": false,
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "dimensions_unit": "cm",
      "weight_unit": "kg",
      "volume": "0.03",
      "editable": false
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 2,
    "pages": 1,
    "from": 1,
    "to": 2,
    "in": 2,
    "previous": null,
    "next": null
  }
}

List package types

What this seller packs their goods into: the boxes their parcels ship in, the cartons their products are packed into, the pallets a wholesale order leaves on.

The list carries the marketplace’s own packaging alongside the seller’s, so a seller can pack into the operator’s standard cartons rather than measuring them again. Those rows report editable: false and are refused by every write.

The row marked default is the box this seller’s parcels are quoted with — its size and weight are added to every rate.

GET

api

seller

package_types

Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

const { data: packageTypes } = await client.packageTypes.list({ owner: 'mine' })

{
  "data": [
    {
      "id": "pkgtype_UkLWZg9DAJ",
      "name": "Standard mailer",
      "kind": "box",
      "length": "30.0",
      "width": "20.0",
      "height": "15.0",
      "weight": "0.4",
      "max_weight": null,
      "default": true,
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "dimensions_unit": "cm",
      "weight_unit": "kg",
      "volume": "0.009",
      "editable": true
    },
    {
      "id": "pkgtype_gbHJdmfrXB",
      "name": "Marketplace carton",
      "kind": "carton",
      "length": "40.0",
      "width": "30.0",
      "height": "25.0",
      "weight": null,
      "max_weight": "20.0",
      "default": false,
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "dimensions_unit": "cm",
      "weight_unit": "kg",
      "volume": "0.03",
      "editable": false
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 2,
    "pages": 1,
    "from": 1,
    "to": 2,
    "in": 2,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`default`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`kind`	One of `box`, `envelope`, `carton`, `pallet`, `container`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`seller_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: created_at, default, id, kind, name, seller_id, updated_at. Prefix a field with - to sort descending.

Authorizations

Authorization

string

header

required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id

string

required

Query Parameters

q[search]

string

Matches any of name (partial, case-insensitive).

owner

enum<string>

Narrows the list to the seller's own packaging, leaving out the marketplace's shared rows

Available options:

mine

page

integer

Page number

limit

integer

Records per page (max 100)

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

Response

200 - application/json

package types listed

data

object[]

required

Show child attributes

API basics

Endpoints

List package types

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters