Get trigger promotions list

Description

Returns a list of loyalty program trigger promotions. Pagination and filtering by active status are supported.

Request URL

Method: POST

https://example.com/api/v1.1/loyalty/trigger_promotions

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abc123def456"	Yes	API token
loyalty_program_id	int	123	Yes	Loyalty program ID
from_id	int	0	No	Promotion ID for pagination (records with ID > from_id)
limit	int	20	No	Number of records (1–100), default 20
is_active	boolean	true	No	Active status filter: true — active, false — inactive, omitted — all

Request example

JSON

{
  "token": "abc123def456",
  "loyalty_program_id": 123,
  "limit": 20,
  "is_active": true
}

XML

<xml>
  <token>abc123def456</token>
  <loyalty_program_id>123</loyalty_program_id>
  <limit>20</limit>
  <is_active>true</is_active>
</xml>

Response example

JSON

{
  "data": [
    {
      "id": 5,
      "name": "Trigger promotion: Bonus for purchase",
      "description": "Bonus accrual for each purchase",
      "external_id": "trigger_promo_2023_q3",
      "start_date": "2023-09-01T00:00:00Z",
      "end_date": "2023-09-30T23:59:59Z",
      "is_active": true,
      "redeem_rules": [
        {
          "points_currency_iid": 1,
          "points_currency_eid": "curr1",
          "static_amount": "100.16",
          "min_amount": "50",
          "max_amount": "500"
        }
      ],
      "accrual_rules": [
        {
          "points_currency_iid": 1,
          "points_currency_eid": "curr1",
          "static_amount": "100",
          "min_amount": "50",
          "max_amount": "500"
        }
      ]
    }
  ],
  "next_from_id": 8,
  "total_count": 134,
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <id>5</id>
    <name>Trigger promotion: Bonus for purchase</name>
    <description>Bonus accrual for each purchase</description>
    <external_id>trigger_promo_2023_q3</external_id>
    <start_date>2023-09-01T00:00:00Z</start_date>
    <end_date>2023-09-30T23:59:59Z</end_date>
    <is_active>true</is_active>
  </data>
  <next_from_id>8</next_from_id>
  <total_count>134</total_count>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Unique promotion ID
name	string	Promotion name
description	string	Promotion description
external_id	string	External promotion ID
start_date	string (RFC3339)	Start date
end_date	string (RFC3339)	End date
is_active	boolean	Active flag
redeem_rules	array	Redemption rules (points currency, values)
accrual_rules	array	Accrual rules (points currency, values)
next_from_id	int	ID for the next page
total_count	int	Total number of promotions