Get discounted products sorted by discount percentage
Changed onRequest
- Base URLhttps://api.buywhere.ai/v1
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
ISO-4217 currency of the listings to return. Default: the currency of country_code, else of deliver_to, else SGD.
Filter by ISO-3166 alpha-2 country code (alias: country). When set, only deals from that country are returned, in its currency unless currency is given.
Minimum discount percentage. Discounts of 80 percent or more are excluded as implausible list-price inflation, so useful values are 0-79.
Recommended for buyer-facing use: ISO-3166 country of the end user. Sets the market currency when currency is omitted and labels each item availability (local, ships_to_you, unavailable, unknown).
With deliver_to, set false to drop items that cannot be delivered there (meta.total reflects the kept items).
Response
Discounted products with price, original_price, and discount_pct
Changes
- breaking
for the
queryrequest parametercurrency, default valueSGDwas removed - breaking
removed the enum value
MYfrom thequeryrequest parametercountry_code - breaking
removed the enum value
SGfrom thequeryrequest parametercountry_code - breaking
removed the enum value
THfrom thequeryrequest parametercountry_code - breaking
removed the enum value
USfrom thequeryrequest parametercountry_code - breaking
removed the enum value
VNfrom thequeryrequest parametercountry_code - info
added the new optional
queryrequest parameterdeliver_to - info
added the new optional
queryrequest parameterinclude_unshippable
- breaking