Get list of bonus promotions

Get list of bonus promotionsServer-sideAdmin

get/v2/project/{project_id}/admin/promotion/bonus

Gets the list of bonus promotions of a project.

Promotion adds free bonus items to the purchase made by a user. The promotion can be applied to every purchase within a project or to a purchase that includes particular items.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056

query Parameters

limit	integer Limit for the number of elements on the page. Example: limit=50
offset	integer Number of the element from which the list is generated (the count starts from 0). Example: offset=0

Responses

200

List of bonus promotions was successfully received.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

Request samples

Response samples

application/json

{"promotions": [{"id": 1,
"date_start": "2020-04-15T18:16:00+05:00",
"date_end": "2020-04-25T18:16:00+05:00",
"name": {"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"is_enabled": true,
"condition": [{"sku": "elven_boots"
},
{"sku": "elven_knife"
}
],
"bonus": [{"sku": "elven_sword",
"quantity": 1
},
{"sku": "elven_shield",
"quantity": 2
},
{"sku": "elven_gloves",
"quantity": 2
}
],
"limits": {"per_user": null,
"per_item": null,
"recurrent_schedule": null
}
},
{"id": 2,
"date_start": "2020-04-15T18:16:00+05:00",
"date_end": "2020-04-25T18:16:00+05:00",
"name": {"en-US": "Summer season bonus",
"de-DE": "Sommersaison Bonus"
},
"is_enabled": true,
"condition": null,
"bonus": [{"sku": "diamonds",
"quantity": 100
}
],
"limits": {"per_user": {"total": 10
},
"per_item": null,
"recurrent_schedule": {"per_user": {"interval_type": "daily",
"day_of_week": null,
"day_of_month": null,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
}
}
],
"total_promotions_count": 2,
"active_promotions_count": 2,
"inactive_promotions_count": 0
}