Spree Seller SDK

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

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

const { data: payouts } = await client.payouts.list({
  status_eq: 'completed',
  sort: '-period_end',
})

{
  "data": [
    {
      "id": "vpo_UkLWZg9DAJ",
      "status": "pending",
      "currency": "USD",
      "reference": null,
      "period_start": null,
      "period_end": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "amount": "120.00",
      "transfers_count": 1,
      "provider": "system"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

List payouts

Settlements to this seller: each one batches the transfers that had accumulated since the last, on the seller’s payout schedule. pending and processing rows are owed; completed ones reached the seller’s bank. transfers_count says how many earnings a settlement covers — list them with GET /api/v3/seller/transfers?q[payout_id_eq]=….

Read-only: a payout is created by the marketplace’s sweep and confirmed by the payout provider or the operator.

GET

api

seller

payouts

Spree Seller SDK

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

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

const { data: payouts } = await client.payouts.list({
  status_eq: 'completed',
  sort: '-period_end',
})

{
  "data": [
    {
      "id": "vpo_UkLWZg9DAJ",
      "status": "pending",
      "currency": "USD",
      "reference": null,
      "period_start": null,
      "period_end": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "amount": "120.00",
      "transfers_count": 1,
      "provider": "system"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[provider_cont]=…. 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`
`period_end`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`period_start`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`provider`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`reference`	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`
`status`	One of `pending`, `processing`, `completed`, `failed`, `unresolved`	`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: amount, created_at, currency, id, period_end, period_start, provider, reference, seller_id, status, 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 reference (partial, case-insensitive).

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

payouts listed

data

object[]

required

Show child attributes

API basics

Endpoints

List payouts

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters