Spree Admin SDK

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

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

// `amount` is the fee and `tax_amount` is the VAT charged on that fee — two
// separate supplies, which is why they are not folded together.
const { data: commissionLines } = await client.commissionLines.list({ page: 1, limit: 25 })

{
  "data": [
    {
      "id": "cline_UkLWZg9DAJ",
      "kind": "percentage",
      "currency": "USD",
      "taxability_reason": null,
      "country_code": null,
      "state_code": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "rate": "10",
      "tax_rate": "0",
      "amount": "10.00",
      "tax_amount": "2.10",
      "total": "12.10",
      "order_id": "or_UkLWZg9DAJ",
      "seller_id": "sel_UkLWZg9DAJ",
      "line_item_id": "li_UkLWZg9DAJ",
      "fulfillment_id": null,
      "commission_rate_id": null,
      "seller_name": "Sparks Audio"
    }
  ],
  "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 lines

What each sale actually earned the marketplace, frozen when the order was placed. A later change to a commission rate never reaches these.

amount is the fee charged to the seller and tax_amount is the VAT on that fee — the marketplace’s own service to the seller, a supply separate from the sale itself, which is why the two are not folded together. total is their sum.

One line per commissioned item, plus one per delivery when the rate that applied charges shipping too — read line_item_id and fulfillment_id to tell them apart.

Read-only: correcting a charge is a reversal, not an edit.

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

GET

api

admin

commission_lines

Spree Admin SDK

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

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

// `amount` is the fee and `tax_amount` is the VAT charged on that fee — two
// separate supplies, which is why they are not folded together.
const { data: commissionLines } = await client.commissionLines.list({ page: 1, limit: 25 })

{
  "data": [
    {
      "id": "cline_UkLWZg9DAJ",
      "kind": "percentage",
      "currency": "USD",
      "taxability_reason": null,
      "country_code": null,
      "state_code": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "rate": "10",
      "tax_rate": "0",
      "amount": "10.00",
      "tax_amount": "2.10",
      "total": "12.10",
      "order_id": "or_UkLWZg9DAJ",
      "seller_id": "sel_UkLWZg9DAJ",
      "line_item_id": "li_UkLWZg9DAJ",
      "fulfillment_id": null,
      "commission_rate_id": null,
      "seller_name": "Sparks Audio"
    }
  ],
  "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[amount_eq]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`amount`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`currency`	One of the `CurrencyCode` codes	`eq` `not_eq` `in` `not_in` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`kind`	One of `percentage`, `fixed`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`order_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`rate`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`tax_amount`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`total`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`updated_at`	Date and time	`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_rate_id_eq]. The same predicates apply.

Prefix	Attributes
`commission_rate_`	`code`, `created_at`, `enabled`, `id`, `include_shipping`, `kind`, `name`, `position`, `tax_inclusive`, `updated_at`, `value`
`commission_rate_commission_rules_`	`created_at`, `id`, `updated_at`
`seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`

Sort by: amount, created_at, currency, id, kind, order_id, rate, tax_amount, total, updated_at. 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

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., -created_at).

expand

string

Comma-separated associations to embed (e.g., commission_rate).

Response

commission lines found

data

object[]

required

Show child attributes

API basics

Endpoints

List commission lines

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters