products - storefront - QUERY

Version: 2024-04

Description:

Returns a list of the shop's products. For storefront search, use the [`search`](https://shopify.dev/docs/api/storefront/latest/queries/search) query.

Access Scopes

Arguments

  • 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. | name | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | | available_for_sale | Filter by products that have at least one product variant available for sale. | | created_at | Filter by the date and time when the product was created. | | | - `created_at:>'2020-10-21T23:39:20Z'`
    - `created_at: - `created_at:<=2024` | | product_type | Filter by a comma-separated list of [product types](https://help.shopify.com/en/manual/products/details/product-type). | | | `product_type:snowboard` | | tag | Filter products by the product [`tags`](https://shopify.dev/docs/api/storefront/latest/objects/Product#field-tags) field. | | | `tag:my_tag` | | tag_not | Filter by products that don't have the specified product [tags](https://shopify.dev/docs/api/storefront/latest/objects/Product#field-tags). | | | `tag_not:my_tag` | | title | Filter by the product [`title`](https://shopify.dev/docs/api/storefront/latest/objects/Product#field-title) field. | | | `title:The Minimal Snowboard` | | updated_at | Filter by the date and time when the product was last updated. | | | - `updated_at:>'2020-10-21T23:39:20Z'`
    - `updated_at: - `updated_at:<=2024` | | variants.price | Filter by the price of the product's variants. | | vendor | Filter by the product [`vendor`](https://shopify.dev/docs/api/storefront/latest/objects/Product#field-vendor) field. | | | - `vendor:Snowdevil`
    - `vendor:Snowdevil OR vendor:Icedevil` | Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
  • reverse: Boolean - Reverse the order of the underlying list.
  • sortKey: ProductSortKeys - Sort the underlying list by the given key.

Returns

  • edges: ProductEdge! A list of edges.
  • filters: Filter! A list of available filters.
  • nodes: Product! A list of the nodes contained in ProductEdge.
  • pageInfo: PageInfo! Information to aid in pagination.

Examples

  • Retrieve first three products

            Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query getProducts($first: Int) { products(first: $first) { edges { cursor node { title } } } }\"\n}'\n"
        Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query getProducts($first: Int) {\n    products(first: $first) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n});\n"
        Ruby example: null
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<query([\"query\" => $query]);\n"
        Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query getProducts($first: Int) {\n    products(first: $first) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
        Graphql query: "query getProducts($first: Int) {\n  products(first: $first) {\n    edges {\n      cursor\n      node {\n        title\n      }\n    }\n  }\n}"
      
    input: null
    response: {
  "data": {
    "products": {
      "edges": [
        {
          "cursor": "eyJsYXN0X2lkIjo2NTcyMTE2NSwibGFzdF92YWx1ZSI6IjY1NzIxMTY1In0=",
          "node": {
            "title": "Storefront Spoon"
          }
        },
        {
          "cursor": "eyJsYXN0X2lkIjoyNjMwNzE4NTYsImxhc3RfdmFsdWUiOiIyNjMwNzE4NTYifQ==",
          "node": {
            "title": "Storefront Shoes"
          }
        },
        {
          "cursor": "eyJsYXN0X2lkIjo1Mzg4MjUyNjEsImxhc3RfdmFsdWUiOiI1Mzg4MjUyNjEifQ==",
          "node": {
            "title": "Guitar"
          }
        }
      ]
    }
  }
}

    Retrieve first three products in reverse order

            Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query getProducts($first: Int, $reverse: Boolean) { products(first: $first, reverse: $reverse) { edges { cursor node { title } } } }\"\n}'\n"
        Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query getProducts($first: Int, $reverse: Boolean) {\n    products(first: $first, reverse: $reverse) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n});\n"
        Ruby example: null
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<query([\"query\" => $query]);\n"
        Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query getProducts($first: Int, $reverse: Boolean) {\n    products(first: $first, reverse: $reverse) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
        Graphql query: "query getProducts($first: Int, $reverse: Boolean) {\n  products(first: $first, reverse: $reverse) {\n    edges {\n      cursor\n      node {\n        title\n      }\n    }\n  }\n}"
      
    input: null
    response: {
  "data": {
    "products": {
      "edges": [
        {
          "cursor": "eyJsYXN0X2lkIjo5Mjk4OTg0NjUsImxhc3RfdmFsdWUiOiI5Mjk4OTg0NjUifQ==",
          "node": {
            "title": "Camper Van"
          }
        },
        {
          "cursor": "eyJsYXN0X2lkIjo1Mzg4MjUyNjEsImxhc3RfdmFsdWUiOiI1Mzg4MjUyNjEifQ==",
          "node": {
            "title": "Guitar"
          }
        },
        {
          "cursor": "eyJsYXN0X2lkIjoyNjMwNzE4NTYsImxhc3RfdmFsdWUiOiIyNjMwNzE4NTYifQ==",
          "node": {
            "title": "Storefront Shoes"
          }
        }
      ]
    }
  }
}

    Retrieve first two products after cursor

            Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query getProducts($first: Int, $after: String) { products(first: $first, after: $after) { edges { cursor node { title } } } }\"\n}'\n"
        Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query getProducts($first: Int, $after: String) {\n    products(first: $first, after: $after) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n});\n"
        Ruby example: null
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<query([\"query\" => $query]);\n"
        Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query getProducts($first: Int, $after: String) {\n    products(first: $first, after: $after) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
        Graphql query: "query getProducts($first: Int, $after: String) {\n  products(first: $first, after: $after) {\n    edges {\n      cursor\n      node {\n        title\n      }\n    }\n  }\n}"
      
    input: null
    response: {
  "data": {
    "products": {
      "edges": [
        {
          "cursor": "eyJsYXN0X2lkIjoyNjMwNzE4NTYsImxhc3RfdmFsdWUiOiIyNjMwNzE4NTYifQ==",
          "node": {
            "title": "Storefront Shoes"
          }
        },
        {
          "cursor": "eyJsYXN0X2lkIjo1Mzg4MjUyNjEsImxhc3RfdmFsdWUiOiI1Mzg4MjUyNjEifQ==",
          "node": {
            "title": "Guitar"
          }
        }
      ]
    }
  }
}

    Retrieve last two products before cursor

            Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query getProducts($last: Int, $before: String) { products(last: $last, before: $before) { edges { cursor node { title } } } }\"\n}'\n"
        Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query getProducts($last: Int, $before: String) {\n    products(last: $last, before: $before) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n});\n"
        Ruby example: null
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<query([\"query\" => $query]);\n"
        Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query getProducts($last: Int, $before: String) {\n    products(last: $last, before: $before) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
        Graphql query: "query getProducts($last: Int, $before: String) {\n  products(last: $last, before: $before) {\n    edges {\n      cursor\n      node {\n        title\n      }\n    }\n  }\n}"
      
    input: null
    response: {
  "data": {
    "products": {
      "edges": [
        {
          "cursor": "eyJsYXN0X2lkIjo2NTcyMTE2NSwibGFzdF92YWx1ZSI6IjY1NzIxMTY1In0=",
          "node": {
            "title": "Storefront Spoon"
          }
        },
        {
          "cursor": "eyJsYXN0X2lkIjoyNjMwNzE4NTYsImxhc3RfdmFsdWUiOiIyNjMwNzE4NTYifQ==",
          "node": {
            "title": "Storefront Shoes"
          }
        }
      ]
    }
  }
}

    Retrieve product that matches the query

            Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query getProducts($first: Int, $query: String) { products(first: $first, query: $query) { edges { cursor node { title } } } }\"\n}'\n"
        Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query getProducts($first: Int, $query: String) {\n    products(first: $first, query: $query) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n});\n"
        Ruby example: null
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<query([\"query\" => $query]);\n"
        Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query getProducts($first: Int, $query: String) {\n    products(first: $first, query: $query) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
        Graphql query: "query getProducts($first: Int, $query: String) {\n  products(first: $first, query: $query) {\n    edges {\n      cursor\n      node {\n        title\n      }\n    }\n  }\n}"
      
    input: null
    response: {
  "data": {
    "products": {
      "edges": [
        {
          "cursor": "eyJsYXN0X2lkIjo1Mzg4MjUyNjEsImxhc3RfdmFsdWUiOiI1Mzg4MjUyNjEifQ==",
          "node": {
            "title": "Guitar"
          }
        }
      ]
    }
  }
}

    Retrieve products after sorting by a key

            Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query getProducts($first: Int, $sortKey: ProductSortKeys) { products(first: $first, sortKey: $sortKey) { edges { cursor node { title } } } }\"\n}'\n"
        Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query getProducts($first: Int, $sortKey: ProductSortKeys) {\n    products(first: $first, sortKey: $sortKey) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n});\n"
        Ruby example: null
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<query([\"query\" => $query]);\n"
        Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query getProducts($first: Int, $sortKey: ProductSortKeys) {\n    products(first: $first, sortKey: $sortKey) {\n      edges {\n        cursor\n        node {\n          title\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
        Graphql query: "query getProducts($first: Int, $sortKey: ProductSortKeys) {\n  products(first: $first, sortKey: $sortKey) {\n    edges {\n      cursor\n      node {\n        title\n      }\n    }\n  }\n}"
      
    input: null
    response: {
  "data": {
    "products": {
      "edges": [
        {
          "cursor": "eyJsYXN0X2lkIjo5Mjk4OTg0NjUsImxhc3RfdmFsdWUiOiJDYW1wZXIgVmFuIn0=",
          "node": {
            "title": "Camper Van"
          }
        },
        {
          "cursor": "eyJsYXN0X2lkIjo1Mzg4MjUyNjEsImxhc3RfdmFsdWUiOiJHdWl0YXIifQ==",
          "node": {
            "title": "Guitar"
          }
        },
        {
          "cursor": "eyJsYXN0X2lkIjoyNjMwNzE4NTYsImxhc3RfdmFsdWUiOiJTdG9yZWZyb250IFNob2VzIn0=",
          "node": {
            "title": "Storefront Shoes"
          }
        },
        {
          "cursor": "eyJsYXN0X2lkIjo2NTcyMTE2NSwibGFzdF92YWx1ZSI6IlN0b3JlZnJvbnQgU3Bvb24ifQ==",
          "node": {
            "title": "Storefront Spoon"
          }
        }
      ]
    }
  }
}