Seller schema
The unified SocialCrawl seller offer schema. Every field, its type, per-platform availability, and a machine-readable JSON Schema, generated from the canonical Zod source.
Every SocialCrawl endpoint that returns a seller offer gives you this exact shape, whatever the source platform. Write your parser once and the same code reads seller data from every platform below. That is the unified schema: one contract instead of a dozen raw upstream formats.
Field reference
| Field | Type | Nullable | Description |
|---|---|---|---|
id | string | Yes | The seller's id: its domain or a slug of its name. |
name | string | Yes | Seller name |
domain | string | Yes | Domain of the seller's site. |
url | string | Yes | URL of the seller's offer page. |
price.base | number | Yes | Item price before tax and shipping, in the price currency. |
price.tax | number | Yes | Tax, in the price currency. |
price.shipping | number | Yes | Shipping cost, in the price currency. |
price.total | number | Yes | Total price including tax and shipping, in the price currency. |
price.currency | string | Yes | Currency code of the prices. |
rating.average | number | Yes | Average rating of the seller, normally out of 5. |
rating.count | number | Yes | Number of ratings behind the average. |
condition | string | Yes | Item condition (e.g. "New", "Refurbished - Excellent") |
availability | string | Yes | Stock status of the offer as the seller words it. |
annotation | string | Yes | Note shown with the offer, for example a special offer. |
Platform availability
5 platforms return the Seller shape. yes means the platform populates the field (the value may still be null); a blank means the platform never provides it, so it is always null.
| Platform | annotation | availability | condition | domain | id | price.base | price.currency | price.shipping | price.total | rating.average | rating.count | price.tax |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Amazon | yes | yes | yes | yes | yes | yes | yes | yes | yes | |||
| Google Shopping | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | |
| Gumtree | yes | yes | ||||||||||
| Klarna | yes | |||||||||||
| Walmart | yes | yes | yes | yes | yes | yes | yes | yes |
Machine-readable schema
Validate responses programmatically against the JSON Schema (2020-12):
Point a validator (Ajv, jsonschema, or your framework's) at that URL, or hand it to an agent so it can check the shape without a live call.
Returned by
Endpoints with the Seller / SellerList archetype return this shape:
Amazon · Google Shopping · Gumtree · Klarna · Walmart
See how the same fields map to each platform's raw upstream names in the cross-platform field equivalence table.
Review schema
The unified SocialCrawl review schema. Every field, its type, per-platform availability, and a machine-readable JSON Schema, generated from the canonical Zod source.
Place schema
The unified SocialCrawl place or business schema. Every field, its type, per-platform availability, and a machine-readable JSON Schema, generated from the canonical Zod source.
