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 ChatGPT endpoint. Shopping cards are part of the ChatGPT response, so no separate API call is needed.

​
Example request

Shopping cards are opt-in. Set include.shopping: true in your request to include them in the response. 
{
  "prompt": "What are the best sneakers under $100?",
  "model": "CHATGPT",
  "country": "US",
  "include": {
    "shopping": true
  }
}
This produces a response containing the shoppingCards array documented below.

​
Overview

Shopping cards are extracted when ChatGPT returns product or commercial information. Set include.shopping: true in your request to include them in the response.
Shopping cards in ChatGPT
Opt-in featureShopping cards extraction is disabled by default. You must explicitly set include.shopping: true to extract shopping cards from ChatGPT responses. Enabling include.shopping adds +2 credits to the base cost.
Model availabilityShopping cards mostly appear when ChatGPT uses the gpt-5-3-mini model. ChatGPT automatically selects which model to use for each request, so shopping cards may not be present in all responses.

​
Shopping card structure

Each shopping card contains:
FieldTypeDescription
tagsarrayCategory tags for the shopping card (e.g., [“electronics”, “deals”])
productsarrayArray of product information objects

​
Product information

Each product includes the following e-commerce data:
FieldTypeDescription
titlestringProduct name
urlstringProduct page URL with ChatGPT attribution
descriptionstringProduct description
pricestringCurrent price (e.g., “$57.00”)
original_pricestringOriginal price before discount
featured_tagstringProduct category or style tag
merchantsstringMerchant names (e.g., “Amazon.in + others”)
image_urlsarrayArray of product image URLs
ratingfloatProduct rating (0-5 scale)
num_reviewsintegerNumber of reviews
idstringUnique product identifier
citestringCitation reference identifier (e.g., “turn0product0”)
offersarrayArray of shopping offers from different merchants
offersSeeMoreBoundaryintegerNumber of offers shown before “see more”
rating_grouped_citationobjectRating source information with supporting websites
showcaseMetadataobjectProduct showcase display metadata with image positioning
providersarrayList of data provider identifiers
productLookupKeyobjectKey used to look up product updates
productLookupDataobjectStructured product lookup query data
showPriceDisclosurebooleanWhether to show price disclosure
analyticsMetaobjectAnalytics metadata with productEventUuid
metadataSourcesarraySources of product metadata (e.g., [“p2”])
generatedProductQuerystringBroad shopping query ChatGPT generated for this product (e.g., “best microwaves uk 2026 countertop inverter combi microwave”)

​
Offer information

Each offer contains merchant-specific details:
FieldTypeDescription
merchant_namestringMerchant name (e.g., “Amazon.in”, “Macy’s”)
merchant_subtitlestringAdditional merchant information
marketplace_sellerstringThird-party seller on the marketplace
seller_namestringSeller name
brandstringProduct brand
product_namestringProduct name as listed by merchant
urlstringOffer URL with ChatGPT attribution
pricestringOffer price (e.g., “$57.00”)
detailsstringStock and delivery information
original_pricestringOriginal price before discount
availablebooleanOffer availability status
checkoutablebooleanWhether offer can be checked out directly
checkout_payloadstringCheckout payload data
checkout_image_urlsarrayImages for checkout flow
is_digitalbooleanWhether product is digital
price_detailsobjectDetailed price breakdown (see below)
tagobjectPromotional tag (see below)
shop_idstringShop identifier
providerstringProvider code (e.g., “p2”)

​
Price details

Offers include detailed price breakdown:
FieldTypeDescription
display_pricestringFormatted display price
basestringBase product price
shippingstringShipping cost
taxstringTax amount
totalstringTotal price including any additional costs

​
Offer tag

Promotional tags on offers:
FieldTypeDescription
textstringTag text (e.g., “Best price”)
tooltipstringTag tooltip text

​
Rating citation information

Products include rating source attribution:
FieldTypeDescription
titlestringSource title
urlstringSource URL
supporting_websitesarrayArray of supporting website references
attributionstringAttribution text (may be null)
pubDatestringPublication date (may be null)
snippetstringContent snippet (may be null)
attributionSegmentsarrayAttribution segments (may be null)
refsarrayReference objects
huestringColor hue (may be null)

​
Supporting website

Used by: rating_grouped_citation.supporting_websites
FieldTypeDescription
titlestringSupporting website title
urlstringSupporting website URL
pub_datestringPublication date (may be null)
snippetstringContent snippet (may be null)

​
Showcase metadata

Display metadata for product images, available on inline products:
FieldTypeDescription
imageobjectImage info: url, width, height
backgroundobjectBackground colors: type, primary, secondary
slotsobjectNamed display slots with positioning and fit data

​
Example usage

{
  "prompt": "What are the best sneakers under $100?",
  "model": "CHATGPT",
  "country": "US",
  "include": {
    "shopping": true
  }
}
Response with shopping cards: 
{
  "success": true,
  "result": {
    "text": "If you're shopping for sneakers under $100, here are some options...",
    "shoppingCards": [
      {
        "tags": [
          "stylish casual leather sneaker",
          "heritage retro leather sneaker",
          "canvas everyday skate-inspired"
        ],
        "products": [
          {
            "title": "Adidas VL Court 3.0",
            "url": "https://www.adidas.com/us/vl-court-3.0-shoes/ID8797.html?utm_source=chatgpt.com",
            "price": "$57.00",
            "featured_tag": "stylish casual leather sneaker",
            "merchants": "adidas + others",
            "cite": "turn0product0",
            "image_urls": [
              "https://images.openai.com/static-rsc-1/AY2CiYu1..."
            ],
            "id": "3250714974047560249",
            "rating": 4.7,
            "num_reviews": 10394,
            "showPriceDisclosure": false,
            "offersSeeMoreBoundary": 3,
            "providers": ["product_info"],
            "metadataSources": ["p2"],
            "offers": [
              {
                "merchant_name": "adidas",
                "seller_name": "adidas",
                "product_name": "Adidas Women's VL Court 3.0",
                "url": "https://www.adidas.com/us/vl-court-3.0-shoes/ID8797.html?utm_source=chatgpt.com",
                "price": "$57.00",
                "details": "In stock online and nearby, Delivery between Sat - Mon $4.99",
                "original_price": null,
                "available": true,
                "checkoutable": false,
                "is_digital": null,
                "provider": "p2",
                "price_details": {
                  "base": "$57.00",
                  "total": "$57.00"
                },
                "tag": {
                  "text": "Best price"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}