Get all promotion list

Get all promotion listServer-sideAdmin

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

Gets the list of promotions of a project.

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
enabled	integer Filter elements by `is_enabled` flag.

Responses

200

List of 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-01-01T00:00",
"date_end": null,
"name": "promotion_1",
"type": "item_bonus",
"is_enabled": true,
"bonus": [{"item": {"description": null,
"image_url": null,
"sku": "diamonds_pack",
"name": {"en-US": "Diamonds pack",
"ru-RU": "Пак кристаллов"
},
"type": "bundle",
"bundle_type": "virtual_currency_package",
"content": [ ]
},
"quantity": 1
}
],
"condition": [{"item": {"description": null,
"image_url": null,
"sku": "virtual_good_bonus_2",
"name": {"en-US": "VG name",
"ru-RU": "Название VG"
},
"type": "virtual_good",
"inventory_options": {"consumable": true,
"expiration_period": null
}
}
}
],
"discount": null
},
{"id": 2,
"date_start": "2020-01-01T00:00",
"date_end": "2030-01-01T00:00",
"name": "promotion_2",
"type": "item_discount",
"is_enabled": false,
"bonus": null,
"condition": [{"item": {"description": null,
"image_url": null,
"sku": "virtual_good_bonus_2",
"name": {"en-US": "VG name",
"ru-RU": "Название VG"
},
"type": "virtual_good",
"inventory_options": {"consumable": true,
"expiration_period": null
}
}
}
],
"discount": {"percent": "10.99"
}
},
{"id": 3,
"date_start": "2022-01-01T00:00",
"date_end": "2030-01-01T00:00",
"name": "promotion_3",
"type": "coupon_bonus",
"is_enabled": true,
"bonus": [{"item": {"description": null,
"image_url": null,
"sku": "virtual_good_bonus_2",
"name": {"en-US": "VG name",
"ru-RU": "Название VG"
},
"type": "virtual_good",
"inventory_options": {"consumable": true,
"expiration_period": null
}
},
"quantity": 2
}
],
"condition": [{"item": {"external_id": "coupon_2",
"name": {"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"is_enabled": true,
"redeem_total_limit": null,
"redeem_user_limit": null,
"redeem_code_limit": 1
}
}
],
"discount": null
},
{"id": 4,
"date_start": "2018-01-01T00:00",
"date_end": "2031-01-01T00:00",
"name": "promotion_4",
"type": "promocode_bonus_discount",
"is_enabled": false,
"bonus": [{"item": {"description": null,
"image_url": null,
"sku": "virtual_good_bonus_2",
"name": {"en-US": "VG name",
"ru-RU": "Название VG"
},
"type": "virtual_good",
"inventory_options": {"consumable": true,
"expiration_period": null
}
},
"quantity": 2
}
],
"condition": [{"item": {"external_id": "coupon_3",
"name": {"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"is_enabled": true,
"redeem_total_limit": null,
"redeem_user_limit": null,
"redeem_code_limit": 1
}
}
],
"discount": {"percent": "12.99"
}
},
{"id": 5,
"date_start": "2020-01-01T00:00",
"date_end": null,
"name": "promotion_5",
"type": "cart_bonus",
"is_enabled": true,
"bonus": [{"item": {"description": null,
"image_url": null,
"sku": "virtual_good_bonus_4",
"name": {"en-US": "VG name",
"ru-RU": "Название VG"
},
"type": "virtual_good"
},
"quantity": 1
}
],
"condition": null,
"discount": null
}
],
"total_promotions_count": 5,
"active_promotions_count": 3,
"inactive_promotions_count": 2
}