Import promo codes
Description
Imports one or multiple promo codes into a loyalty program.
Request URL
Method: POST
https://example.com/api/v1.1/promocodes/import
Request example
Parameter | Type | Example | Required | Description |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
format | string | "json" | No | Response data format. By default – json |
codes | JSON array | ["CODE-1", "CODE-2"] | Yes | Promo codes list |
loyalty_id | int | 1 | Yes | Loyalty program ID |
Request example
{
"codes": [
"CODE-1",
"CODE-2"
],
"loyalty_id": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}
Response example
{
"data": [
{
"code": "CODE-1",
"error": 0,
"error_text": ""
},
{
"code": "CODE-2",
"error": 500,
"error_text": "Promocode duplicated"
}
],
"discarded_by_limit": 0,
"duplicated": 1,
"error": 0,
"error_text": "Successful operation",
"inserted": 1
}
Response parameters
Parameter | Type | Description |
---|---|---|
error | int | Error code |
error_text | string | Error text |
code | string | Promo code |
discarded_by_limit | int | Import error due to loyalty program limitations |
duplicated | int | Import error due to duplication |
inserted | int | Number of successfully imported promo codes |