List Products

GET

admin

products

curl 'http://localhost:9000/admin/products?status[]=published&limit=20' \
  -H 'Authorization: Bearer <token>'

const { products, count } = await client.admin.products.query({
  status: ["published"],
  limit: 20,
})

{
  "products": [
    {
      "id": "prod_01HXYZABCDEF",
      "title": "Linen Shirt",
      "handle": "linen-shirt",
      "status": "published",
      "thumbnail": "https://cdn.example.com/linen-shirt.png",
      "variants": [
        { "id": "variant_01HXYZABCDEF", "title": "M", "sku": "LS-M", "variant_rank": 0 }
      ],
      "created_at": "2026-06-01T10:00:00.000Z",
      "updated_at": "2026-06-01T10:00:00.000Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns all products across the marketplace, with optional filtering by status, seller, category, and more.

Query parameters

number

default:"50"

Maximum number of records to return.

number

default:"0"

Number of records to skip.

string

Field to sort by, prefix with - for descending order.

string

Comma-separated list of fields to include, prefix with +/- to add or remove from defaults.

string

Search term matched against product fields.

string | string[]

Filter by product ID(s).

string

Filter by product title.

string

Filter by product handle.

string | string[]

Filter by the seller(s) eligible to sell the product.

string[]

Filter by status: draft, proposed, published, or rejected.

string | string[]

Filter by collection ID(s).

string | string[]

Filter by product type ID(s).

string | string[]

Filter by category ID(s).

string | string[]

Filter by tag ID(s).

string

Filter by variant SKU.

string

Filter by variant EAN.

string

Filter by variant UPC.

string

Filter by variant barcode.

boolean

Filter to products that have (or don’t have) seller offers.

object

Filter by creation date with operators like $gte, $lte.

object

Filter by update date with operators like $gte, $lte.

object

Filter by deletion date with operators like $gte, $lte.

Response

object[]

Show properties

string

The product’s ID.

string

Product title.

string

Product subtitle.

string

One of draft, proposed, published, rejected.

string

Product description.

string

Unique URL-safe handle.

boolean

Whether the product is a gift card.

boolean

Whether discounts can apply to the product.

string

URL of the product thumbnail.

string

ID of the product in an external system.

string

ID of the product’s collection.

string

ID of the product’s type.

object

The collection with id, title, and handle.

object[]

Categories with id, name, and handle.

object[]

Variants with id, title, sku, manage_inventory, allow_backorder, and variant_rank.

object[]

Attribute values selected on the product, each with its parent attribute.

object[]

Product-scoped (inline) attributes with their values.

object[]

Computed attribute groups, each with the selected values and the attribute’s full all_values.

number

Product weight.

number

Product length.

number

Product height.

number

Product width.

string

Harmonized System code.

string

Manufacturer identification code.

string

Country of origin.

string

Product material.

object

Custom key-value data.

string

Creation timestamp.

string

Last update timestamp.

number

Total number of matching products.

number

Number of records skipped.

number

Number of records returned.

curl 'http://localhost:9000/admin/products?status[]=published&limit=20' \
  -H 'Authorization: Bearer <token>'

const { products, count } = await client.admin.products.query({
  status: ["published"],
  limit: 20,
})

{
  "products": [
    {
      "id": "prod_01HXYZABCDEF",
      "title": "Linen Shirt",
      "handle": "linen-shirt",
      "status": "published",
      "thumbnail": "https://cdn.example.com/linen-shirt.png",
      "variants": [
        { "id": "variant_01HXYZABCDEF", "title": "M", "sku": "LS-M", "variant_rank": 0 }
      ],
      "created_at": "2026-06-01T10:00:00.000Z",
      "updated_at": "2026-06-01T10:00:00.000Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/admin/products?status[]=published&limit=20' \
  -H 'Authorization: Bearer <token>'

const { products, count } = await client.admin.products.query({
  status: ["published"],
  limit: 20,
})

{
  "products": [
    {
      "id": "prod_01HXYZABCDEF",
      "title": "Linen Shirt",
      "handle": "linen-shirt",
      "status": "published",
      "thumbnail": "https://cdn.example.com/linen-shirt.png",
      "variants": [
        { "id": "variant_01HXYZABCDEF", "title": "M", "sku": "LS-M", "variant_rank": 0 }
      ],
      "created_at": "2026-06-01T10:00:00.000Z",
      "updated_at": "2026-06-01T10:00:00.000Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response