productRecommendations - storefront - QUERY

Version: 2024-01

Description:

Find recommended products related to a given `product_id`. To learn more about how recommendations are generated, see [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products).

Access Scopes

Arguments

• intent: ProductRecommendationIntent - The recommendation intent that is used to generate product recommendations. You can use intent to generate product recommendations on various pages across the channels, according to different strategies.
• productId: ID! - The id of the product.

Returns

• availableForSale: Boolean! Indicates if at least one product variant is available for sale.
• compareAtPriceRange: ProductPriceRange! The [compare-at price range](https://help.shopify.com/manual/products/details/product-pricing/sale-pricing) of the product in the shop's default currency.
• createdAt: DateTime! The date and time when the product was created.
• description: String! A single-line description of the product, with [HTML tags](https://developer.mozilla.org/en-US/docs/Web/HTML) removed.
• descriptionHtml: HTML! The description of the product, with HTML tags. For example, the description might include bold `<strong></strong>` and italic `<i></i>` text.
• featuredImage: Image The featured image for the product. This field is functionally equivalent to `images(first: 1)`.
• handle: String! A unique, human-readable string of the product's title. A handle can contain letters, hyphens (`-`), and numbers, but no spaces. The handle is used in the online store URL for the product.
• id: ID! A globally-unique ID.
• isGiftCard: Boolean! Whether the product is a gift card.
• metafield: Metafield A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• metafields: Metafield! A list of [custom fields](/docs/apps/build/custom-data) that a merchant associates with a Shopify resource.
• onlineStoreUrl: URL The product's URL on the online store. If `null`, then the product isn't published to the online store sales channel.
• options: ProductOption! A list of product options. The limit is defined by the [shop's resource limits for product options](/docs/api/admin-graphql/latest/objects/Shop#field-resourcelimits) (`Shop.resourceLimits.maxProductOptions`).
• priceRange: ProductPriceRange! The minimum and maximum prices of a product, expressed in decimal numbers. For example, if the product is priced between $10.00 and $50.00, then the price range is $10.00 - $50.00.
• productType: String! The [product type](https://help.shopify.com/manual/products/details/product-type) that merchants define.
• publishedAt: DateTime! The date and time when the product was published to the channel.
• requiresSellingPlan: Boolean! Whether the product can only be purchased with a [selling plan](/docs/apps/build/purchase-options/subscriptions/selling-plans). Products that are sold on subscription (`requiresSellingPlan: true`) can be updated only for online stores. If you update a product to be subscription-only (`requiresSellingPlan:false`), then the product is unpublished from all channels, except the online store.
• seo: SEO! The [SEO title and description](https://help.shopify.com/manual/promoting-marketing/seo/adding-keywords) that are associated with a product.
• tags: String! A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the `sports` and `summer` tags to products that are associated with sportwear for summer. Updating `tags` overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the GraphQL Admin API's [`tagsAdd`](/docs/api/admin-graphql/latest/mutations/tagsadd) mutation.
• title: String! The name for the product that displays to customers. The title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses", then the handle is `black-sunglasses`.
• totalInventory: Int The quantity of inventory that's in stock.
• trackingParameters: String URL parameters to be added to a page URL to track the origin of on-site search traffic for [analytics reporting](https://help.shopify.com/manual/reports-and-analytics/shopify-reports/report-types/default-reports/behaviour-reports). Returns a result when accessed through the [search](https://shopify.dev/docs/api/storefront/current/queries/search) or [predictiveSearch](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries, otherwise returns null.
• updatedAt: DateTime! The date and time when the product was last modified. A product's `updatedAt` value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.
• variantBySelectedOptions: ProductVariant Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, `null` will be returned.
• vendor: String! The name of the product's vendor.

Examples

• Retrieve recommendations for a product

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query productRecommendations($productId: ID!) { productRecommendations(productId: $productId) { id } }\"\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 productRecommendations($productId: ID!) {\n    productRecommendations(productId: $productId) {\n      id\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\n  query productRecommendations($productId: ID!) {\n    productRecommendations(productId: $productId) {\n      id\n    }\n  }\nQUERY;\n\n$response = $client->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 productRecommendations($productId: ID!) {\n    productRecommendations(productId: $productId) {\n      id\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query productRecommendations($productId: ID!) {\n  productRecommendations(productId: $productId) {\n    id\n  }\n}"
        

  input: null

  response: {
    "data": {
      "productRecommendations": [
        {
          "id": "gid://shopify/Product/538825261"
        },
        {
          "id": "gid://shopify/Product/263071856"
        },
        {
          "id": "gid://shopify/Product/65721165"
        }
      ]
    }
  }

  Retrieve recommendations tailored for a supported intent

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query getComplementaryProductRecommendations($productId: ID!, $intent: ProductRecommendationIntent!) { productRecommendations(productId: $productId, intent: $intent) { id } }\"\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 getComplementaryProductRecommendations($productId: ID!, $intent: ProductRecommendationIntent!) {\n    productRecommendations(productId: $productId, intent: $intent) {\n      id\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\n  query getComplementaryProductRecommendations($productId: ID!, $intent: ProductRecommendationIntent!) {\n    productRecommendations(productId: $productId, intent: $intent) {\n      id\n    }\n  }\nQUERY;\n\n$response = $client->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 getComplementaryProductRecommendations($productId: ID!, $intent: ProductRecommendationIntent!) {\n    productRecommendations(productId: $productId, intent: $intent) {\n      id\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query getComplementaryProductRecommendations($productId: ID!, $intent: ProductRecommendationIntent!) {\n  productRecommendations(productId: $productId, intent: $intent) {\n    id\n  }\n}"
        

  input: null

  response: {
    "data": {
      "productRecommendations": [
        {
          "id": "gid://shopify/Product/263071856"
        }
      ]
    }
  }