> ## Documentation Index
> Fetch the complete documentation index at: https://cloro.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Shopping cards
> Schema for structured shopping cards extracted from ChatGPT responses, including product titles, pricing, ratings, merchant offers, and commercial details.
This section documents the **shopping cards** data returned by the [ChatGPT endpoint](/api-reference/endpoint/monitor-chatgpt). 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.
```json theme={null}
{
"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.
**Opt-in feature**
Shopping 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 availability**
Shopping 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:
| Field | Type | Description |
| ---------- | ----- | --------------------------------------------------------------------- |
| `tags` | array | Category tags for the shopping card (e.g., \["electronics", "deals"]) |
| `products` | array | Array of product information objects |
## Product information
Each product includes the following e-commerce data:
| Field | Type | Description |
| -------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `title` | string | Product name |
| `position` | integer | 1-indexed rank across all products in all shopping cards in the response (flat, not reset per card). |
| `url` | string | Product page URL with ChatGPT attribution |
| `description` | string | Product description |
| `price` | string | Current price (e.g., "\$57.00") |
| `featured_tag` | string | Product category or style tag |
| `merchants` | string | Merchant names (e.g., "Amazon.in + others") |
| `image_urls` | array | Array of product image URLs |
| `rating` | float | Product rating (0-5 scale) |
| `num_reviews` | integer | Number of reviews |
| `id` | string | Unique product identifier |
| `cite` | string | Citation reference identifier (e.g., "turn0product0") |
| `offers` | array | Array of shopping offers from different merchants |
| `offers_see_more_boundary` | integer | Number of offers shown before "see more" |
| `rating_grouped_citation` | object | Rating source information with supporting websites |
| `showcase_metadata` | object | Product showcase display metadata with image positioning |
| `providers` | array | List of data provider identifiers |
| `product_lookup_key` | object | Key used to look up product updates |
| `product_lookup_data` | object | Structured product lookup query data |
| `show_price_disclosure` | boolean | Whether to show price disclosure |
| `analytics_meta` | object | Analytics metadata with `product_event_uuid` |
| `metadata_sources` | array | Sources of product metadata (e.g., \["p2"]) |
| `generatedProductQuery` | string | Broad 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:
| Field | Type | Description |
| --------------------- | ------- | ------------------------------------------- |
| `merchant_name` | string | Merchant name (e.g., "Amazon.in", "Macy's") |
| `merchant_subtitle` | string | Additional merchant information |
| `marketplace_seller` | string | Third-party seller on the marketplace |
| `seller_name` | string | Seller name |
| `brand` | string | Product brand |
| `product_name` | string | Product name as listed by merchant |
| `url` | string | Offer URL with ChatGPT attribution |
| `price` | string | Offer price (e.g., "\$57.00") |
| `details` | string | Stock and delivery information |
| `original_price` | string | Original price before discount |
| `available` | boolean | Offer availability status |
| `checkoutable` | boolean | Whether offer can be checked out directly |
| `checkout_payload` | string | Checkout payload data |
| `checkout_image_urls` | array | Images for checkout flow |
| `is_digital` | boolean | Whether product is digital |
| `price_details` | object | Detailed price breakdown (see below) |
| `tag` | object | Promotional tag (see below) |
| `shop_id` | string | Shop identifier |
| `provider` | string | Provider code (e.g., "p2") |
## Price details
Offers include detailed price breakdown:
| Field | Type | Description |
| --------------- | ------ | ------------------------------------------ |
| `display_price` | string | Formatted display price |
| `base` | string | Base product price |
| `shipping` | string | Shipping cost |
| `tax` | string | Tax amount |
| `total` | string | Total price including any additional costs |
## Offer tag
Promotional tags on offers:
| Field | Type | Description |
| --------- | ------ | ----------------------------- |
| `text` | string | Tag text (e.g., "Best price") |
| `tooltip` | string | Tag tooltip text |
## Rating citation information
Products include rating source attribution:
| Field | Type | Description |
| ---------------------- | ------ | -------------------------------------- |
| `title` | string | Source title |
| `url` | string | Source URL |
| `supporting_websites` | array | Array of supporting website references |
| `attribution` | string | Attribution text (may be null) |
| `pub_date` | string | Publication date (may be null) |
| `snippet` | string | Content snippet (may be null) |
| `attribution_segments` | array | Attribution segments (may be null) |
| `refs` | array | Reference objects |
| `hue` | string | Color hue (may be null) |
### Supporting website
Used by: `rating_grouped_citation.supporting_websites`
| Field | Type | Description |
| ---------- | ------ | ------------------------------ |
| `title` | string | Supporting website title |
| `url` | string | Supporting website URL |
| `pub_date` | string | Publication date (may be null) |
| `snippet` | string | Content snippet (may be null) |
## Showcase metadata
Display metadata for product images, available on inline products:
| Field | Type | Description |
| ------------ | ------ | ------------------------------------------------- |
| `image` | object | Image info: `url`, `width`, `height` |
| `background` | object | Background colors: `type`, `primary`, `secondary` |
| `slots` | object | Named display slots with positioning and fit data |
## Example usage
```json theme={null}
{
"prompt": "What are the best sneakers under $100?",
"model": "CHATGPT",
"country": "US",
"include": {
"shopping": true
}
}
```
**Response with shopping cards:**
```json theme={null}
{
"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",
"position": 1,
"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,
"show_price_disclosure": false,
"offers_see_more_boundary": 3,
"providers": ["product_info"],
"metadata_sources": ["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"
}
}
]
}
]
}
]
}
}
```