SocialCrawl
Unified schema

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

FieldTypeNullableDescription
idstringYesThe seller's id: its domain or a slug of its name.
namestringYesSeller name
domainstringYesDomain of the seller's site.
urlstringYesURL of the seller's offer page.
price.basenumberYesItem price before tax and shipping, in the price currency.
price.taxnumberYesTax, in the price currency.
price.shippingnumberYesShipping cost, in the price currency.
price.totalnumberYesTotal price including tax and shipping, in the price currency.
price.currencystringYesCurrency code of the prices.
rating.averagenumberYesAverage rating of the seller, normally out of 5.
rating.countnumberYesNumber of ratings behind the average.
conditionstringYesItem condition (e.g. "New", "Refurbished - Excellent")
availabilitystringYesStock status of the offer as the seller words it.
annotationstringYesNote 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.

Platformannotationavailabilityconditiondomainidprice.baseprice.currencyprice.shippingprice.totalrating.averagerating.countprice.tax
Amazonyesyesyesyesyesyesyesyesyes
Google Shoppingyesyesyesyesyesyesyesyesyesyesyes
Gumtreeyesyes
Klarnayes
Walmartyesyesyesyesyesyesyesyes

Machine-readable schema

Validate responses programmatically against the JSON Schema (2020-12):

/schemas/seller.json

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.

On this page