Get discounted products sorted by discount percentage

Changed on
get/products/deals

Request

Query parameters

currencystring

ISO-4217 currency of the listings to return. Default: the currency of country_code, else of deliver_to, else SGD.

country_codestring

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.

min_discountnumber

Minimum discount percentage. Discounts of 80 percent or more are excluded as implausible list-price inflation, so useful values are 0-79.

limitinteger
offsetinteger
deliver_tostring

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).

include_unshippableboolean

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 query request parameter currency, default value SGD was removed

    • breaking

      removed the enum value MY from the query request parameter country_code

    • breaking

      removed the enum value SG from the query request parameter country_code

    • breaking

      removed the enum value TH from the query request parameter country_code

    • breaking

      removed the enum value US from the query request parameter country_code

    • breaking

      removed the enum value VN from the query request parameter country_code

    • info

      added the new optional query request parameter deliver_to

    • info

      added the new optional query request parameter include_unshippable