Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cloro.dev/llms.txt

Use this file to discover all available pages before exploring further.

This section documents the shopping cards data returned by the Perplexity endpoint. Shopping cards are part of the Perplexity response, so no separate API call is needed.

Example request

Shopping cards are intent-detected by Perplexity. Send a prompt that expresses shopping intent (for example, asking for product recommendations or where to buy). No flag is required.
{
  "prompt": "best running shoes under $150",
  "country": "US"
}
This produces a response containing the shopping_cards array documented below.

Overview

Perplexity automatically detects shopping-intent queries and returns structured shopping cards with product listings, pricing, ratings, and offers.

Shopping card structure

FieldTypeDescription
result.shopping_cardsarrayShopping product cards with detailed product information
Each shopping card contains:
FieldTypeDescription
productsarrayArray of product objects
tagsarrayOptional category tags

Product structure

Each product object includes:
FieldTypeDescription
titlestringProduct name
urlstringProduct page URL
descriptionstringProduct description
pricestringCurrent price
original_pricestringOriginal price before discount
ratingnumberProduct rating (0-5)
numReviewsnumberNumber of reviews
imageUrlsarrayProduct image URLs
merchantstringMerchant name
idanyProduct identifier
variantsarrayProduct variants (size, color, etc.)
offersarrayShopping offers with pricing details

Response example

{
  "success": true,
  "result": {
    "text": "Here are several running shoes under $150...",
    "shopping_cards": [
      {
        "tags": ["running", "athletic"],
        "products": [
          {
            "title": "Nike Pegasus 41",
            "url": "https://www.nike.com/t/pegasus-41",
            "description": "Responsive cushioning for daily training runs.",
            "price": "$140.00",
            "original_price": null,
            "rating": 4.6,
            "numReviews": 1284,
            "imageUrls": [
              "https://static.nike.com/pegasus-41.jpg"
            ],
            "merchant": "Nike",
            "id": "nike-pegasus-41",
            "variants": [],
            "offers": [
              {
                "merchant": "Nike",
                "price": "$140.00",
                "url": "https://www.nike.com/t/pegasus-41"
              }
            ]
          }
        ]
      }
    ]
  }
}