Loyaly/loyaly-catalogue
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MD Doc Updates

Browse Source
This commit is contained in:
sriram
2026-10-05 11:27:35 +05:30
parent 705aec2a74
commit 82f5db1250
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/API.md
View File

@@ -123,7 +123,7 @@ Everything from the list item, plus:
| `canonical_specs` | Normalised specs, e.g. `ram_gb`, `storage_gb`, `display_inch`, `processor`, `battery_mah`, `os` |
| `spec_sources` | Per spec, the page it was read from |
| `images[]` | `url`, `site`, `found_on` (page the image is on), `source_type` |
| `rating` | `{ value, count, sources: [{ site, rating, review_count, source_url }] }`, or `null` |
| `rating` | `{ value, count, breakdown, sources: [{ site, rating, review_count, breakdown, source_url }] }`, or `null` when no platform publishes a rating. `breakdown` is `[{ stars: 5, count, percent }, … { stars: 1, … }]`, summed over the platforms that publish one, or `null`; it is never estimated |
| `reviews[]` | Up to 10 real customer reviews: `site`, `source_url`, `author`, `rating`, `title`, `body`, `review_date`, `sentiment` (`positive` / `neutral` / `negative`, from the reviewer's own stars) |
One offer from the response:
@@ -145,6 +145,7 @@ Notes:
- **`source_type`** says how a value was read: `scraped_page` (the platform's product page), `brand_official` (the brand's site) or `search_snippet` (a search-engine result; Amazon and Flipkart are only read this way).
- **`price_outlier: true`** marks a search-engine price that disagrees with the product-page prices. It is kept for transparency but never used as `best_price`.
- **`in_stock`** is `true`, `false` or `null` (not stated). `best_price` prefers in-stock offers, but a product that is out of stock everywhere still shows its price.
- **Where ratings and reviews come from** (free, robots-allowed sources only): brand stores that publish reviews as schema.org data (currently Samsung India), Reliance Digital and Poorvika page data (ratings and star breakdown), and Vijay Sales' public review feed. Amazon and Flipkart pages are not read.
- **Reviews are often empty**: most retailers do not publish review text in a readable form, and none are invented.
### `GET /api/elec/products/{product_id}/price-history`