Spree Admin SDK

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

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

// `catalog_price` adds what a buyer on this agreement pays for each product.
const { data: products } = await client.catalogs.products.list('cat_UkLWZg9DAJ', {
  expand: ['catalog_price'],
})

{
  "data": [
    {
      "id": "prod_UkLWZg9DAJ",
      "name": "Product 12159",
      "thumbnail_url": null,
      "catalog_variants": [
        {
          "id": "variant_UkLWZg9DAJ",
          "label": null,
          "sku": "SKU-1",
          "currency": "USD",
          "source": "automatic",
          "break_count": 0,
          "amount": "80.00",
          "tiers": []
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

List catalog products

The catalog’s curated assortment, listed by product name — membership carries no order.

expand=catalog_price adds what a buyer on this agreement pays for each row and where the amount comes from: explicit (an amount entered on the catalog’s own price list), automatic (that list’s percentage applied to the shop price) or base (the shop price itself — this agreement does not price the product).

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

GET

api

admin

catalogs

{catalog_id}

products

Spree Admin SDK

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

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

// `catalog_price` adds what a buyer on this agreement pays for each product.
const { data: products } = await client.catalogs.products.list('cat_UkLWZg9DAJ', {
  expand: ['catalog_price'],
})

{
  "data": [
    {
      "id": "prod_UkLWZg9DAJ",
      "name": "Product 12159",
      "thumbnail_url": null,
      "catalog_variants": [
        {
          "id": "variant_UkLWZg9DAJ",
          "label": null,
          "sku": "SKU-1",
          "currency": "USD",
          "source": "automatic",
          "break_count": 0,
          "amount": "80.00",
          "tiers": []
        }
      ]
    }
  ],
  "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[name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`available_on`	Date and time	`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`
`description`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`discontinue_on`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`id`	Prefixed ID	`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`
`price`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`seller_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`slug`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`status`	One of `draft`, `active`, `archived`, `proposed`, `rejected`	`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`

Filters through associations

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

Prefix	Attributes
`categories_`	`automatic`, `children_count`, `created_at`, `depth`, `id`, `name`, `parent_id`, `permalink`, `position`, `pretty_name`, `products_count`, `updated_at`
`categories_parent_`	`automatic`, `children_count`, `created_at`, `depth`, `id`, `name`, `parent_id`, `permalink`, `position`, `pretty_name`, `products_count`, `updated_at`
`channels_`	`active`, `code`, `created_at`, `default`, `id`, `name`, `store_id`, `updated_at`
`collections_`	`automatic`, `created_at`, `id`, `name`, `permalink`, `position`, `products_count`, `sort_order`, `updated_at`
`default_variant_`	`carton_package_type_id`, `carton_weight`, `cartons_per_pallet`, `cost_currency`, `cost_price`, `country_of_origin`, `created_at`, `deleted_at`, `depth`, `discontinue_on`, `height`, `hs_code`, `id`, `minimum_order_quantity`, `order_multiple`, `position`, `product_id`, `purchase_unit`, `sku`, `track_inventory`, `units_per_carton`, `updated_at`, `weight`, `width`
`default_variant_option_values_`	`created_at`, `id`, `label`, `name`, `position`, `updated_at`
`default_variant_prices_`	`amount`, `compare_at_amount`, `created_at`, `currency`, `id`, `min_quantity`, `price_list_id`, `updated_at`, `variant_id`
`default_variant_seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`default_variant_tax_category_`	`created_at`, `id`, `is_default`, `name`, `tax_code`, `updated_at`
`labels_`	`created_at`, `id`, `name`, `updated_at`
`option_types_`	`created_at`, `id`, `kind`, `label`, `name`, `position`, `updated_at`
`product_categories_`	`category_id`, `created_at`, `id`, `position`, `product_id`, `updated_at`
`product_type_`	`created_at`, `id`, `name`, `updated_at`
`product_type_option_types_`	`created_at`, `id`, `kind`, `label`, `name`, `position`, `updated_at`
`seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`store_`	`created_at`, `id`, `name`, `updated_at`
`tags_`	`created_at`, `id`, `name`, `updated_at`
`variants_`	`carton_package_type_id`, `carton_weight`, `cartons_per_pallet`, `cost_currency`, `cost_price`, `country_of_origin`, `created_at`, `deleted_at`, `depth`, `discontinue_on`, `height`, `hs_code`, `id`, `minimum_order_quantity`, `order_multiple`, `position`, `product_id`, `purchase_unit`, `sku`, `track_inventory`, `units_per_carton`, `updated_at`, `weight`, `width`
`variants_option_values_`	`created_at`, `id`, `label`, `name`, `position`, `updated_at`
`variants_prices_`	`amount`, `compare_at_amount`, `created_at`, `currency`, `id`, `min_quantity`, `price_list_id`, `updated_at`, `variant_id`
`variants_seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`variants_tax_category_`	`created_at`, `id`, `is_default`, `name`, `tax_code`, `updated_at`

Sort by: available_on, created_at, description, discontinue_on, id, name, price, seller_id, slug, status, 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

Path Parameters

catalog_id

string

required

Query Parameters

q[search]

string

Matches product name or variant SKU (partial, case-insensitive), and the store's searchable custom fields.

q[ascend_by_price]

boolean

Set to true to apply ascend_by_price.

q[descend_by_price]

boolean

Set to true to apply descend_by_price.

q[in_categories][]

string[]

Applies in_categories to the given value.

q[in_category]

string

Applies in_category to the given value.

q[in_collection]

string

Applies in_collection to the given value.

q[in_stock]

boolean

Set to true to apply in_stock.

q[in_taxon]

string

Applies in_taxon to the given value.

q[not_discontinued]

boolean

Set to true to apply not_discontinued.

q[out_of_stock]

boolean

Set to true to apply out_of_stock.

q[price_between][]

number[]

Applies price_between to the given value.

Required array length: 2 elements

q[price_gte]

number

Applies price_gte to the given value.

q[price_lte]

number

Applies price_lte to the given value.

q[search_by_name]

string

Applies search_by_name to the given value.

q[with_option_value_ids][]

string[]

Applies with_option_value_ids to the given value.

expand

string

Comma-separated. catalog_price adds the resolved price to every row.

object

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

Response

200 - application/json

products found, with what the agreement charges

data

object[]

required

Show child attributes

API basics

Endpoints

List catalog products

Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

Filters