> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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). ## Filters Filter with `q[_]=value`, for example `q[name_cont]=…`. Send a list as `q[_in][]=a&q[_in][]=b`. [How filters work](/docs/api-reference/admin-api/querying.md#which-filters-an-endpoint-accepts). | 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. ## OpenAPI ````yaml /api-reference/admin.yaml get /api/v3/admin/catalogs/{catalog_id}/products openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Email Templates description: >- Customer email templates, the email layout and shared partials: drafts, previews, publishing and history - name: Exports description: Async CSV exports of admin resources - name: Files description: Uploading the files that product media, imports, logos and documents use - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Policies description: The store's legal documents — terms of service, privacy, returns, shipping - name: Reasons description: >- Merchant-owned vocabularies for why a return, claim, refund, cancellation or tax exemption happened - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, and configuration - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Store Credits description: Prepaid customer balances across all customers, and each balance's ledger - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/catalogs/{catalog_id}/products: get: tags: - Catalogs summary: List catalog products description: |- 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). parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string - name: catalog_id in: path required: true schema: type: string - name: q[search] in: query required: false schema: type: string description: >- Matches product name or variant SKU (partial, case-insensitive), and the store's searchable custom fields. - name: q[ascend_by_price] in: query required: false schema: type: boolean description: Set to `true` to apply `ascend_by_price`. - name: q[descend_by_price] in: query required: false schema: type: boolean description: Set to `true` to apply `descend_by_price`. - name: q[in_categories][] in: query required: false schema: type: array items: type: string description: Applies `in_categories` to the given value. - name: q[in_category] in: query required: false schema: type: string description: Applies `in_category` to the given value. - name: q[in_collection] in: query required: false schema: type: string description: Applies `in_collection` to the given value. - name: q[in_stock] in: query required: false schema: type: boolean description: Set to `true` to apply `in_stock`. - name: q[in_taxon] in: query required: false schema: type: string description: Applies `in_taxon` to the given value. - name: q[not_discontinued] in: query required: false schema: type: boolean description: Set to `true` to apply `not_discontinued`. - name: q[out_of_stock] in: query required: false schema: type: boolean description: Set to `true` to apply `out_of_stock`. - name: q[price_between][] in: query required: false schema: type: array items: type: number minItems: 2 maxItems: 2 description: Applies `price_between` to the given value. - name: q[price_gte] in: query required: false schema: type: number description: Applies `price_gte` to the given value. - name: q[price_lte] in: query required: false schema: type: number description: Applies `price_lte` to the given value. - name: q[search_by_name] in: query required: false schema: type: string description: Applies `search_by_name` to the given value. - name: q[with_option_value_ids][] in: query required: false schema: type: array items: type: string description: Applies `with_option_value_ids` to the given value. - name: expand in: query required: false description: >- Comma-separated. `catalog_price` adds the resolved price to every row. example: catalog_price schema: type: string - name: q in: query required: false style: deepObject explode: true schema: type: object additionalProperties: true description: >- Attribute filters, as `q[_]=value`. See Filters above for the list. responses: '200': description: products found, with what the agreement charges content: application/json: example: 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 schema: type: object properties: data: type: array items: $ref: '#/components/schemas/CatalogProduct' meta: $ref: '#/components/schemas/PaginationMeta' required: - data - meta security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: >- 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'], }) - lang: bash label: Spree CLI source: >- spree api get /catalogs/{catalog_id}/products -d '{"expand":["catalog_price"]}' components: schemas: CatalogProduct: type: object properties: id: type: string name: type: string thumbnail_url: type: string nullable: true quantity_rule: allOf: - $ref: '#/components/schemas/CatalogProductTerm' nullable: true catalog_variants: type: array items: $ref: '#/components/schemas/CatalogPrice' required: - id - name - thumbnail_url x-typelizer: true PaginationMeta: type: object properties: page: type: integer example: 1 limit: type: integer example: 25 count: type: integer example: 100 description: Total number of records pages: type: integer example: 4 description: Total number of pages from: type: integer example: 1 description: Index of first record on this page to: type: integer example: 25 description: Index of last record on this page in: type: integer example: 25 description: Number of records on this page previous: type: integer nullable: true example: null description: Previous page number next: type: integer nullable: true example: 2 description: Next page number required: - page - limit - count - pages - from - to - in CatalogProductTerm: type: object properties: id: type: string product_id: type: string product_name: type: string nullable: true minimum_order_quantity: type: number nullable: true order_multiple: type: number nullable: true mixed: type: boolean required: - id - product_id - product_name - minimum_order_quantity - order_multiple - mixed x-typelizer: true CatalogPrice: type: object properties: id: type: string nullable: true label: type: string nullable: true sku: type: string nullable: true currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MTL - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SKK - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMM - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYI - UYU - UYW - UZS - VED - VEF - VES - VND - VUV - WST - XAF - XCD - XCG - XOF - XPF - YER - ZAR - ZMK - ZMW - ZWD - ZWG - ZWL - ZWN - ZWR source: type: string enum: - explicit - automatic - base break_count: type: number amount: type: string tiers: type: array items: $ref: '#/components/schemas/CatalogPriceTier' required: - id - label - sku - currency - source - break_count - amount - tiers x-typelizer: true CatalogPriceTier: type: object properties: min_quantity: type: number amount: type: string required: - min_quantity - amount x-typelizer: true securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.