
Shopping cards in Copilot
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
The AI Assistant is here to help — ask it anything instead of browsing through the pages.
Schema for shopping product cards returned by the Microsoft Copilot endpoint, including product titles, pricing, ratings, merchant offers, and image URLs.

Shopping cards in Copilot
{
"prompt": "What are the best laptops for software development?",
"country": "US"
}
| Field | Type | Description |
|---|---|---|
type | string | Shopping card type (e.g., “shoppingProducts”) |
layout | string | Layout style (e.g., “Carousel”) |
products | array | Array of detailed product information objects |
| Field | Type | Description |
|---|---|---|
product | object | Product identifier with id, groupId, brandGroupId |
position | integer | 1-indexed rank across all products in all shopping cards in the response (flat, not reset per card). |
offerId | string | Unique offer identifier |
url | string | Product page URL |
name | string | Product name |
description | string | Product description |
images | array | Product images with title and url |
specifications | array | Product specs (e.g., Color, Size) with displayName and values |
tags | array | Product tags |
price | object | Price information with amount, currency, currencySymbol |
discountPrice | object | Discount price (same structure as price, may be null) |
seller | string | Seller name |
sellerLogoUrl | string | Seller logo URL |
brandName | string | Product brand name |
rating | object | Rating with value and count |
canTrackPrice | boolean | Whether price tracking is available |
| Field | Type | Description |
|---|---|---|
id | string | Unique product ID |
groupId | string | Product group ID |
brandGroupId | string | Brand group ID (optional) |
| Field | Type | Description |
|---|---|---|
amount | number | Price amount |
currency | string | Currency code (optional) |
currencySymbol | string | Currency symbol (e.g., ”$“) |
| Field | Type | Description |
|---|---|---|
value | number | Rating value |
count | integer | Number of ratings |
maxRating | number | Maximum rating scale (may be null) |
{
"success": true,
"result": {
"text": "Here are several laptops for software development...",
"shoppingCards": [
{
"type": "shoppingProducts",
"layout": "Carousel",
"products": [
{
"product": {
"id": "prod_12345",
"groupId": "group_12345"
},
"position": 1,
"offerId": "offer_12345",
"url": "https://www.microsoft.com/en-us/d/surface-laptop-studio-2/8rqr54krf1dz",
"name": "Microsoft Surface Laptop Studio 2",
"description": "Surface laptop with high performance specs",
"images": [
{
"title": "Front view",
"url": "https://example.com/surface.jpg"
}
],
"specifications": [
{
"displayName": "Color",
"values": ["Platinum", "Black"]
}
],
"tags": ["laptop", "professional"],
"price": {
"amount": 1999.99,
"currency": "USD",
"currencySymbol": "$"
},
"seller": "Microsoft Store",
"sellerLogoUrl": "https://example.com/microsoft-logo.png",
"brandName": "Microsoft",
"rating": {
"value": 4.7,
"count": 542
},
"canTrackPrice": true
}
]
}
],
"sources": [
{
"position": 1,
"url": "https://www.microsoft.com/surface",
"label": "Microsoft Surface",
"description": "Official Microsoft Surface product information"
}
]
}
}
Was this page helpful?