List Products

GET

vendor

products

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

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

{
  "products": [
    {
      "id": "prod_01HXYZ",
      "title": "Acme T-Shirt",
      "status": "published",
      "handle": "acme-t-shirt",
      "thumbnail": "https://cdn.example.com/shirt.png",
      "variants": [
        { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns products the seller created plus published products that are not restricted from the seller.

Products are shared master records. This list includes catalog products from other sellers (when published and unrestricted) so you can create offers against them.

Query parameters

number

default:"50"

The maximum number of products to return.

number

default:"0"

The number of products to skip before returning results.

string

The field to sort by, e.g. created_at or -created_at for descending.

string

Comma-separated fields to include in the response. Prefix with +/- to add to or remove from the defaults. Include variants.offers to attach the seller’s offers to each variant.

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[]

Filter by status. Values: draft, proposed, published, 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 the seller has (or has not) created an offer for.

object

Filter by creation date using operators like $gt, $lt, $gte, $lte.

object

Filter by update date using operators like $gt, $lt, $gte, $lte.

object

Filter by deletion date using operators like $gt, $lt, $gte, $lte.

object[]

Join multiple filter objects with a logical AND.

object[]

Join multiple filter objects with a logical OR.

Response

object[]

Show properties

string

The product’s ID.

string

The product’s title.

string

One of draft, proposed, published, rejected.

string

The product’s URL handle.

string

URL of the product’s thumbnail image.

object[]

The product’s images with id, url, and rank.

object

The associated collection with id, title, and handle.

object[]

Associated categories with id, name, and handle.

object[]

The product’s variants with id, title, sku, manage_inventory, allow_backorder, and variant_rank.

object[]

Product attributes grouped per attribute with their selected values.

number

Total number of matching products.

number

Number of skipped products.

number

Maximum number of returned products.

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

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

{
  "products": [
    {
      "id": "prod_01HXYZ",
      "title": "Acme T-Shirt",
      "status": "published",
      "handle": "acme-t-shirt",
      "thumbnail": "https://cdn.example.com/shirt.png",
      "variants": [
        { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

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

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

{
  "products": [
    {
      "id": "prod_01HXYZ",
      "title": "Acme T-Shirt",
      "status": "published",
      "handle": "acme-t-shirt",
      "thumbnail": "https://cdn.example.com/shirt.png",
      "variants": [
        { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
      ]
    }
  ],
  "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