BestPrice Agent Commerce · Schema
Bestprice Search Products Output
ShoppingPrice ComparisonE-CommerceRetailMCPWebMCPAgentic CommerceGreeceProduct RecommendationsShopping DecisionsDelivered Price
JSON Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"schema_version": {
"$ref": "#/$defs/__schema0"
},
"as_of": {
"$ref": "#/$defs/__schema1"
},
"currency": {
"$ref": "#/$defs/__schema2"
},
"locale": {
"$ref": "#/$defs/__schema3"
},
"warnings": {
"$ref": "#/$defs/__schema4"
},
"requested_query": {
"type": "string",
"minLength": 1,
"maxLength": 400
},
"interpreted_query": {
"type": "string",
"minLength": 1,
"maxLength": 400
},
"search_mode": {
"type": "string",
"maxLength": 100,
"pattern": "^[a-z][a-z0-9_]*$",
"description": "How the returned catalog page was retrieved. Known values: catalog_ranked, broadened_category. New values are added without a tools/list change."
},
"applied_filters": {
"type": "object",
"properties": {
"price_min": {
"$ref": "#/$defs/__schema6"
},
"price_max": {
"$ref": "#/$defs/__schema6"
},
"sort": {
"type": "string",
"enum": [
"relevance",
"price_asc",
"price_desc"
]
},
"feature_hints": {
"maxItems": 10,
"type": "array",
"items": {
"$ref": "#/$defs/__schema8"
}
},
"feature_hints_verified": {
"type": "boolean",
"const": false
}
},
"required": [
"price_min",
"price_max",
"sort",
"feature_hints",
"feature_hints_verified"
]
},
"suggested_queries": {
"maxItems": 5,
"type": "array",
"items": {
"$ref": "#/$defs/__schema9"
}
},
"total_matches": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Number of products returned after public scope, price, and result limits; not full catalog cardinality."
},
"products": {
"maxItems": 8,
"type": "array",
"items": {
"$ref": "#/$defs/__schema10"
},
"description": "Grouped BestPrice products. For a barcode (GTIN) query the text search cannot find, at most the one grouped product that carries exactly that barcode, with a warning saying so; a barcode shared by several products returns none."
},
"category_handoff": {
"description": "Present only when products is empty because the matched category holds merchant offers but no grouped BestPrice product yet. url is the plain public category page, not a product landing link. These offers are not comparable products: they have no product_id for compare_offers or get_price_history.",
"$ref": "#/$defs/__schema12"
}
},
"required": [
"schema_version",
"as_of",
"currency",
"locale",
"warnings",
"interpreted_query",
"total_matches",
"products"
]
},
{
"type": "object",
"properties": {
"schema_version": {
"$ref": "#/$defs/__schema0"
},
"as_of": {
"$ref": "#/$defs/__schema1"
},
"currency": {
"$ref": "#/$defs/__schema2"
},
"locale": {
"$ref": "#/$defs/__schema3"
},
"warnings": {
"$ref": "#/$defs/__schema4"
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "^[A-Z][A-Z0-9_]{2,63}$"
},
"message": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable"
]
}
},
"required": [
"schema_version",
"as_of",
"currency",
"locale",
"warnings",
"error"
]
}
],
"$defs": {
"__schema0": {
"type": "string",
"pattern": "^[1-9][0-9]*\\.[0-9]+$",
"description": "Result schema version. Currently 2.0; a later <major>.<minor> is returned without a tools/list change."
},
"__schema1": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"__schema2": {
"type": "string",
"const": "EUR"
},
"__schema3": {
"type": "string",
"const": "el-GR"
},
"__schema4": {
"maxItems": 20,
"type": "array",
"items": {
"$ref": "#/$defs/__schema5"
}
},
"__schema5": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"__schema6": {
"anyOf": [
{
"$ref": "#/$defs/__schema7"
},
{
"type": "null"
}
]
},
"__schema7": {
"type": "number",
"minimum": 0,
"maximum": 10000000
},
"__schema8": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"__schema9": {
"type": "string",
"minLength": 1,
"maxLength": 400
},
"__schema10": {
"type": "object",
"properties": {
"product_id": {
"type": "string",
"pattern": "^bp_[0-9]{10}$"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 220
},
"brand": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 220
},
"variant": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 160
},
{
"type": "null"
}
]
},
"category_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"category_title": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"price_from": {
"description": "Catalog lowest listed item price in EUR before shipping. Same identity as compare_offers.catalog_price_from. Not a buyable quote; it may be a promoted, out-of-stock, or filtered offer that compare_offers omits. Never subtract this from another product compare_offers item_price.",
"$ref": "#/$defs/__schema6"
},
"offer_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"availability": {
"type": "string",
"enum": [
"available",
"unavailable",
"unknown"
]
},
"match_confidence": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Deterministic relative relevance hint based on token coverage and rank; not a probability or feature verification."
},
"match_basis": {
"type": "string",
"maxLength": 100,
"pattern": "^[a-z][a-z0-9_]*_v[1-9][0-9]*$",
"description": "Relevance method behind match_confidence. Currently catalog_relevance_token_coverage_v1; a revised method is returned as a new <name>_v<N> id without a tools/list change."
},
"rating": {
"anyOf": [
{
"$ref": "#/$defs/__schema11"
},
{
"type": "null"
}
],
"description": "BestPrice shopper rating for this product: average of count first-party ratings. Null when the product has none."
},
"data_timestamp": {
"$ref": "#/$defs/__schema1"
},
"decision_id": {
"type": "string",
"pattern": "^d1\\.[a-f0-9]{32}\\.[A-Za-z0-9_-]{43}$",
"description": "Signed, anonymous id joining this recommendation to its BestPrice landing and outbound-click telemetry."
},
"bestprice_url": {
"type": "string",
"format": "uri"
},
"image_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"product_id",
"title",
"brand",
"model",
"variant",
"category_id",
"category_title",
"price_from",
"offer_count",
"availability",
"match_confidence",
"match_basis",
"rating",
"data_timestamp",
"decision_id",
"bestprice_url",
"image_url"
]
},
"__schema11": {
"type": "object",
"properties": {
"average": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"count": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"average",
"count"
]
},
"__schema12": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"url": {
"type": "string",
"format": "uri"
},
"listing_count": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Ungrouped merchant offers BestPrice showed in this category for the search, within any price bounds."
}
},
"required": [
"category_id",
"title",
"url",
"listing_count"
]
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/bestprice-search-products-output"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.