Choose a version:

products

query

Returns a list of the shop's products. For storefront search, use the search query.

ProductConnection arguments

•ProductConnection!

after

•String

Returns the elements that come after the specified cursor.

before

•String

Returns the elements that come before the specified cursor.

first

•Int

Returns up to the first n elements from the list.

last

•Int

Returns up to the last n elements from the list.

query

•String

You can apply one or multiple filters to a query. Learn more about Shopify API search syntax.

Anchor to available_for_sale •: Filter by products that have at least one product variant available for sale.
Anchor to created_at •: Filter by the date and time when the product was created.
Anchor to product_type •: Filter by a comma-separated list of product types.
Anchor to tag •: Filter products by the product tags field.
Anchor to tag_not •: Filter by products that don't have the specified product tags.
Anchor to title •: Filter by the product title field.
Anchor to updated_at •: Filter by the date and time when the product was last updated.
Anchor to variants.price •: Filter by the price of the product's variants.
Anchor to vendor •: Filter by the product vendor field.

reverse

•BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•ProductSortKeysDefault:ID

Sort the underlying list by the given key.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[ProductEdge!]!non-null: A list of edges.
Anchor to filtersfilters •[Filter!]!non-null: A list of available filters.
Anchor to nodesnodes •[Product!]!non-null: A list of the nodes contained in ProductEdge.
Anchor to pageInfopageInfo •PageInfo!non-null: Information to aid in pagination.

Was this section helpful?

Retrieve first three products
Retrieve first three products in reverse order
Retrieve first two products after cursor
Retrieve last two products before cursor
Retrieve product that matches the query
Retrieve products after sorting by a key

Examples

Open in GraphiQL

const { storefront } = await unauthenticated.storefront(

'your-development-store.myshopify.com'

);

const response = await storefront.graphql(

`#graphql

query getProducts($first: Int) {

products(first: $first) {

edges {

cursor

node {

title

}

}`,

);

const data = await response.json();

query getProducts($first: Int) {
  products(first: $first) {
    edges {
      cursor
      node {
        title
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "query getProducts($first: Int) { products(first: $first) { edges { cursor node { title } } } }"
}'

const { storefront } = await unauthenticated.storefront(
  'your-development-store.myshopify.com'
);

const response = await storefront.graphql(
  `#graphql
  query getProducts($first: Int) {
    products(first: $first) {
      edges {
        cursor
        node {
          title
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: `query getProducts($first: Int) {
    products(first: $first) {
      edges {
        cursor
        node {
          title
        }
      }
    }
  }`,
});

Response

JSON

{

"products": {

"edges": [

{

"cursor": "eyJsYXN0X2lkIjo2NTcyMTE2NSwibGFzdF92YWx1ZSI6IjY1NzIxMTY1In0=",

"node": {

"title": "Storefront Spoon"

}

{

"cursor": "eyJsYXN0X2lkIjoyNjMwNzE4NTYsImxhc3RfdmFsdWUiOiIyNjMwNzE4NTYifQ==",

"node": {

"title": "Storefront Shoes"

}

{

"cursor": "eyJsYXN0X2lkIjo1Mzg4MjUyNjEsImxhc3RfdmFsdWUiOiI1Mzg4MjUyNjEifQ==",

"node": {

"title": "Guitar"

}

]

}