Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

// Rates come back with their targeting attached. A rate holding no rules
// applies to every sale.
const { data: commissionRates } = await client.commissionRates.list({ page: 1, limit: 25 })

{
  "data": [
    {
      "id": "crate_UkLWZg9DAJ",
      "name": "Standard",
      "code": null,
      "enabled": true,
      "position": 1,
      "kind": "percentage",
      "tax_inclusive": false,
      "include_shipping": false,
      "metadata": {},
      "deleted_at": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "value": "10",
      "commission_tax_rate": null,
      "amounts": {},
      "bounds": {},
      "global": true,
      "rules": []
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

List commission rates

What the marketplace charges its sellers.

Rates are returned in resolution order: the list is walked top-down and the first rate whose targeting matches the sale wins, so the order you see is the precedence. Move a rate with position on update.

A rate carrying no rules matches every sale — global says so — which is how a marketplace expresses a single default. Because resolution stops at the first match, a global rate makes everything below it unreachable, so it belongs at the bottom.

Required scope: read_commissions (for API-key authentication).

GET

api

admin

commission_rates

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

// Rates come back with their targeting attached. A rate holding no rules
// applies to every sale.
const { data: commissionRates } = await client.commissionRates.list({ page: 1, limit: 25 })

{
  "data": [
    {
      "id": "crate_UkLWZg9DAJ",
      "name": "Standard",
      "code": null,
      "enabled": true,
      "position": 1,
      "kind": "percentage",
      "tax_inclusive": false,
      "include_shipping": false,
      "metadata": {},
      "deleted_at": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "value": "10",
      "commission_tax_rate": null,
      "amounts": {},
      "bounds": {},
      "global": true,
      "rules": []
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

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
`code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`enabled`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`include_shipping`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`kind`	One of `percentage`, `fixed`	`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`
`position`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`tax_inclusive`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`value`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Filters through associations

Prefix an associated record’s attribute with the association, as in q[commission_rules_id_eq]. The same predicates apply.

Prefix	Attributes
`commission_rules_`	`created_at`, `id`, `updated_at`

Sort by: code, created_at, enabled, id, include_shipping, kind, name, position, tax_inclusive, updated_at, value. Prefix a field with - to sort descending.

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

Query Parameters

q[search]

string

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

page

integer

Page number

limit

integer

Number of records per page

object

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

sort

string

Sort by field. Prefix with - for descending (e.g., -position).

Response

commission rates found

data

object[]

required

Show child attributes

API basics

Endpoints

List commission rates

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters