Skip to main content
POST
/openrice/coupons/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
region
enum<string>
default:hongkong
Available options:
hongkong,
macau,
shenzhen,
guangzhou,
zhuhai,
dongguan,
foshan,
zhongshan,
taipei,
newtaipei-keelung,
taoyuan,
hsinchu-miaoli,
taichung,
changhua-nantou,
yunlin-chiayi,
tainan,
kaohsiung-pingtung,
eastern,
tokyo-kanto,
osaka-kobe,
kyoto-kinki,
nagoya-chubu,
hokkaido,
tohoku,
hiroshima-chugoku,
shikoku,
fukuoka-kyushu,
okinawa,
bangkok,
chonburi,
phuket,
prachuapkhirikhan,
chiangmai,
suratthani,
nakhonratchasima,
chiangrai,
others,
singapore,
manila
lang
enum<string>
default:en
Available options:
en,
tc,
sc,
tc-tw,
ja,
th,
id
coupon_type
enum<string>
default:coupon
Available options:
coupon,
voucher,
merchant_offer
keyword
string | null
restaurant
string | null
district_ids
integer[] | null
landmark_ids
integer[] | null
cuisine_ids
integer[] | null
dish_ids
integer[] | null
amenity_ids
integer[] | null
category_group_ids
integer[] | null
promotion_ids
integer[] | null

Response

Successful Response

id
integer
required
coupon_title
string
required
@type
string
default:OpenriceCoupon
url
string | null
subtitle
string | null
terms
string | null
how_to_redeem
string | null
coupon_type_id
integer | null
offer_id
integer | null
booking_menu_id
integer | null
offer_type_id
integer | null
offer_sub_type_id
integer | null
voucher_category_id
integer | null
redeem_method_id
integer | null
discount_type_id
integer | null
discount_value
number | null
discount_label
string | null
original_price
number | null
discount_price
number | null
original_price_text
string | null
discount_price_text
string | null
redemption_limit
integer | null
reference_no
string | null
quota
integer | null
quota_left
integer | null
pre_sales_hours
integer | null
valid_dates
object[]
excluded_dates
object[]
images
string[]
image
string | null
dish_images
string[]
restaurants
object[]
restaurant_display_name
string | null
district_name
string | null
starts_at
integer | null
expires_at
integer | null
redeem_ends_at
integer | null
published_at
integer | null
publish_ends_at
integer | null
bookmark_count
integer | null
sold_count
integer | null
sold_count_text
string | null
is_quota_enabled
boolean
default:false
is_few_stock
boolean
default:false
is_multi_restaurant
boolean
default:false
is_valid_today
boolean
default:false
is_printable
boolean
default:false
has_alcohol_terms
boolean
default:false