Spree Seller SDK
import { createSellerClient } from '@spree/seller-sdk'
const client = createSellerClient({
baseUrl: 'https://your-store.com',
jwtToken: 'eyJhbGciOi...',
})
const me = await client.me.get()curl --request GET \
--url http://{defaultHost}/api/v3/seller/me \
--header 'Authorization: Bearer <token>'{
"user": {
"id": "adm_UkLWZg9DAJ",
"email": "johnny_feest@hodkiewicz.ca",
"first_name": "Nadia",
"last_name": "Effertz",
"full_name": "Nadia Effertz",
"created_at": "2026-01-15T12:00:00.000Z",
"avatar_url": null,
"selected_locale": null
},
"sellers": [
{
"id": "sel_UkLWZg9DAJ",
"name": "Seller 89",
"slug": "seller-89",
"status": "approved"
}
],
"store": {
"id": "store_UkLWZg9DAJ",
"name": "Spree Test Store",
"seller_digital_assets_enabled": false,
"seller_digital_asset_content_types": [
"application/pdf",
"application/epub+zip",
"application/zip",
"application/x-7z-compressed",
"application/gzip",
"application/json",
"text/plain",
"text/csv",
"audio/mpeg",
"audio/mp4",
"audio/aac",
"audio/flac",
"audio/ogg",
"audio/wav",
"audio/x-wav",
"audio/midi",
"video/mp4",
"video/webm",
"video/quicktime",
"image/jpeg",
"image/png",
"image/gif",
"image/webp",
"image/tiff"
],
"review_seller_digital_asset_changes": true
},
"permissions": [
{
"allow": true,
"actions": [
"read"
],
"subjects": [
"country"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read"
],
"subjects": [
"state"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read"
],
"subjects": [
"store"
],
"has_conditions": true
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"product"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"variant"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"option_type"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"option_value"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"price"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"price_list"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"price_rule"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"catalog"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"catalog_product"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"catalog_assignment"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"custom_field"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"digital_asset"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"import"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"import_row"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"product"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"variant"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"option_type"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"option_value"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"price"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"price_list"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"price_rule"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"catalog"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"catalog_product"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"catalog_assignment"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"custom_field"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"digital_asset"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"import"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"import_row"
],
"has_conditions": false
}
],
"permission_keys": [
"read_products",
"write_products"
]
}{
"error": {
"code": "authentication_required",
"message": "Authentication required"
}
}Current user
The signed-in user, the sellers they may act for, and what they may do on the selected one.
This is the one authenticated endpoint that answers without
X-Spree-Seller-Id — it is what tells the panel which seller to name.
Sending the header narrows permission_keys and permissions to that
seller; without it both are empty, because capability is per seller and
there is no answer spanning all of them.
GET
/
api
/
v3
/
seller
/
me
Spree Seller SDK
import { createSellerClient } from '@spree/seller-sdk'
const client = createSellerClient({
baseUrl: 'https://your-store.com',
jwtToken: 'eyJhbGciOi...',
})
const me = await client.me.get()curl --request GET \
--url http://{defaultHost}/api/v3/seller/me \
--header 'Authorization: Bearer <token>'{
"user": {
"id": "adm_UkLWZg9DAJ",
"email": "johnny_feest@hodkiewicz.ca",
"first_name": "Nadia",
"last_name": "Effertz",
"full_name": "Nadia Effertz",
"created_at": "2026-01-15T12:00:00.000Z",
"avatar_url": null,
"selected_locale": null
},
"sellers": [
{
"id": "sel_UkLWZg9DAJ",
"name": "Seller 89",
"slug": "seller-89",
"status": "approved"
}
],
"store": {
"id": "store_UkLWZg9DAJ",
"name": "Spree Test Store",
"seller_digital_assets_enabled": false,
"seller_digital_asset_content_types": [
"application/pdf",
"application/epub+zip",
"application/zip",
"application/x-7z-compressed",
"application/gzip",
"application/json",
"text/plain",
"text/csv",
"audio/mpeg",
"audio/mp4",
"audio/aac",
"audio/flac",
"audio/ogg",
"audio/wav",
"audio/x-wav",
"audio/midi",
"video/mp4",
"video/webm",
"video/quicktime",
"image/jpeg",
"image/png",
"image/gif",
"image/webp",
"image/tiff"
],
"review_seller_digital_asset_changes": true
},
"permissions": [
{
"allow": true,
"actions": [
"read"
],
"subjects": [
"country"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read"
],
"subjects": [
"state"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read"
],
"subjects": [
"store"
],
"has_conditions": true
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"product"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"variant"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"option_type"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"option_value"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"price"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"price_list"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"price_rule"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"catalog"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"catalog_product"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"catalog_assignment"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"custom_field"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"digital_asset"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"import"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"read",
"admin"
],
"subjects": [
"import_row"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"product"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"variant"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"option_type"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"option_value"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"price"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"price_list"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"price_rule"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"catalog"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"catalog_product"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"catalog_assignment"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"custom_field"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"digital_asset"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"import"
],
"has_conditions": false
},
{
"allow": true,
"actions": [
"manage"
],
"subjects": [
"import_row"
],
"has_conditions": false
}
],
"permission_keys": [
"read_products",
"write_products"
]
}{
"error": {
"code": "authentication_required",
"message": "Authentication required"
}
}Authorizations
JWT token for an authenticated seller session (seller_api audience)
Headers
The seller to report capability for. Omit to list sellers without narrowing permissions.
Response
current user returned
The signed-in user, the sellers they may act for, and what they may do on the selected one
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Permission keys on the selected seller. Empty until X-Spree-Seller-Id names one — capability is per seller.
Example:
["read_products", "write_products"]
Was this page helpful?
⌘I