API Reference
SupportSiteVibes Login

List Product Promotions

get
https://api.sitevibes.com/v1/loyalty/product-promotions

List loyalty product promotions data

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

Identifier used to differentiate different applications api is used in

integer
Defaults to 1

The page of paginated data that will be returned

integer
1 to 100
Defaults to 10

The maximum number of objects that may be returned

string
enum
Defaults to newest

Sorting logic

  • newest - order by Newest promotions
  • oldest - order by Oldest promotions
Allowed:
string
enum

Return only specific promotion types

  • products - only product promotions
  • categories - only category promotions
  • brands - only brand promotions
Allowed:
string

Return only promotions for specified product ID

string

Return only promotions for specified product category

string

Return only promotions for specified product brand

boolean

Filter promotions by active state. A promotion is considered active when it is enabled and the current time falls between its start_date and end_date.

  • true - only currently active promotions
  • false - only inactive promotions (disabled, scheduled, or expired)
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?