API ReferenceEnrichmentLookup
Look up one product, free
One product by query string. Free and never charged: it reads your own catalogue, your connected Amazon store, the Open Food Facts database, and whatever an earlier lookup already found on the web. It never runs a search. Use POST to search the web or read a product page. Requires the enrichment:read scope.
AuthorizationBearer <token>
API key in the Authorization header: Authorization: Bearer ace_live_.... Use an ace_test_... key for the free, rate-capped sandbox.
In: header
Query Parameters
q?string
A bare value whose type is worked out for you.
gtin?string
ean?string
upc?string
isbn?string
asin?string
mpn?string
sku?string
brand?string
title?string
market?string
locale?string
projectId?string
include?string
Comma separated: product, facts, sources, conflicts.
maxAgeDays?integer
Range
0 <= value <= 365Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/enrichment/lookup"{ "data": { "operation": "lookup", "items": [ { "index": 0, "ref": "string", "status": "ok", "error": { "code": "string", "message": "string", "details": {} }, "warnings": [ { "code": "INVALID_IDENTIFIER", "field": "string", "value": "string", "reason": "empty", "usedAs": "asin" } ], "match": { "status": "matched", "confidence": 0, "identifiers": { "property1": "string", "property2": "string" }, "partial": true, "candidates": [ {} ] }, "product": { "title": "string", "brand": "string", "description": "string", "bullets": [ "string" ], "category": "string", "images": [ { "url": "string", "source": "string", "sourceUrl": "string", "licence": "string", "attribution": "string" } ], "gtin": "string", "mpn": "string", "asin": "string", "attributes": { "property1": { "value": null, "unit": "string" }, "property2": { "value": null, "unit": "string" } } }, "facts": [ { "field": "title", "name": "string", "value": null, "unit": "string", "source": "catalog", "provider": "open_food_facts", "url": "http://example.com", "retrievedAt": "2019-08-24T14:15:22Z", "matchMethod": "exact_gtin", "extraction": "structured", "confidence": 0, "verified": true, "licence": "ODbL 1.0", "attribution": "string" } ], "sources": [ { "id": "catalog", "status": "hit", "reason": "AMAZON_NOT_CONNECTED", "cached": true, "stale": true, "urls": [ "http://example.com" ], "attribution": { "source": "string", "provider": "string", "text": "string", "licence": "string", "url": "string" }, "retryAfterMs": 0 } ], "conflicts": [ {} ], "content": {}, "generation": { "status": "generated", "reason": "MATCH_NOT_FOUND", "units": [ { "type": "string", "status": "ok", "error": { "code": "string", "message": "string" } } ], "skippedContentTypes": [ "string" ] }, "usage": { "searchCalls": 0, "cacheHits": 0 } } ], "summary": { "total": 0, "matched": 0, "ambiguous": 0, "notFound": 0, "errors": 0, "searchCalls": 0, "cacheHits": 0, "generated": 0, "generationErrors": 0 }, "attributions": [ { "source": "string", "provider": "string", "text": "string", "licence": "string", "url": "string" } ] }}{ "error": { "code": "INSUFFICIENT_CREDITS", "message": "Not enough credits for this request.", "details": null }}{ "error": { "code": "INSUFFICIENT_CREDITS", "message": "Not enough credits for this request.", "details": null }}{ "error": { "code": "PROJECT_SCOPE_MISMATCH", "message": "This API key is scoped to a different project." }}