Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 2 KB

product.md

File metadata and controls

38 lines (30 loc) · 2 KB

Product

A product in a platform shop: price, units sold, rating and shop.

Canonical page: https://okdata.online/docs/objects/product/

The same shape on every platform. A field a platform does not have is null, and meta.unavailable says why. Use fields= to keep only what you need.

Field Type Description
id string Product ID in the shop.
url string Product page.
title string Product title.
price number | null Current price (the lowest variant), in the currency given.
original_price number | null List price before discount, where shown.
currency string | null ISO 4217 currency code.
sold integer | null Units sold, as the shop shows it.
rating number | null Average stars, 0 to 5.
reviews integer | null Number of reviews.
images string[] | null Product image URLs.
shop ShopRef Who sells it.
ext object Platform-specific extras. Only returned with view=full.

ShopRef

Field Type Description
id string | null Shop or seller ID.
name string | null Shop name.
url string | null Shop page.

Endpoints that return a Product