API Reference
Advertiser APIs HomeGuidesAPI ReferenceChangelog

Get a unified list of deals

get
https://{buzz_key}.api.beeswax.com/rest/v2/ref/deals

Retrieves a combined list of deals from multiple sources, including standard deals and optionally curated deals (if the feature flag is enabled). Each entry includes details such as pricing, inventory source, and activity status. The response always includes source (Deal Source), deal_type (Deal Type), name (Supplier Deal Name), name_override (supplier name override), seller_status (Deal Status from seller), and archived (platform active/archived status).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Filter deals by active status.

number
number
number
number
advertiser_id__in
array of numbers

Multiple values may be separated by commas.

advertiser_id__in
boolean
number
number
number
advertiser_id__not_in
array of numbers

Multiple values may be separated by commas.

advertiser_id__not_in
string
string
alternative_id__in
array of strings

Multiple values may be separated by commas.

alternative_id__in
boolean
string
string
alternative_id__not_in
array of strings

Multiple values may be separated by commas.

alternative_id__not_in
string
string
boolean

Archived deals cannot be selected for targeting

date-time
date-time
date-time
boolean
date-time
date-time
date-time | null
enum

The date and time the object was first created

  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
string
string
deal_format__in
array of strings

Multiple values may be separated by commas.

deal_format__in
string
string
deal_format__not_in
array of strings

Multiple values may be separated by commas.

deal_format__not_in
string
deal_id__in
array of strings

Multiple values may be separated by commas.

deal_id__in
string
string
deal_id__not_in
array of strings

Multiple values may be separated by commas.

deal_id__not_in
date-time | null
enum
  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
number
number
number
id__in
array of numbers

Multiple values may be separated by commas.

id__in
number
number
number
id__not_in
array of numbers

Multiple values may be separated by commas.

id__not_in
string

Filter deals by inventory source key.

boolean

Viewability of the inventory source

string
string
name__in
array of strings

Multiple values may be separated by commas.

name__in
string
string
string
name__not_in
array of strings

Multiple values may be separated by commas.

name__not_in
string
string
string

Search deals by name or inventory deal ID.

string

Filter deals by source (manual, curated source value).

string

Filter by deal type (deal, curated_deal).

date-time
date-time
date-time
boolean
date-time
date-time
date-time | null
enum

The date and time the object was last updated

  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
Responses

404

No deals found.

500

Internal server error.

Updated 8 days ago

Language
Credentials
:
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 8 days ago