Obtener la lista de promociones con cupones

Xsolla Developers

A Cuenta del editor

Obtener la lista de promociones con cuponesServer-sideAdmin

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

Obtiene la lista de promociones con cupones de un proyecto.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Example: 44056

query Parameters

limit	integer Límite para el número de elementos presentes en la página. Example: limit=50
offset	integer Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0). Example: offset=0

Responses

200

La lista de cupones se recibió correctamente.

401

Autenticación básica no superada o errónea. Asegúrese de haber utilizado la autenticación básica o las credenciales correctas.

Request samples

curl -i -X GET \
  -u <merchant_id_or_project_id>:<api_key> \
  'https://store.xsolla.com/api/v2/project/{project_id}/admin/coupon?limit=50&offset=0'

Response samples

application/json

{"active_promotions_count": 2,
"inactive_promotions_count": 0,
"items": [{"bonus": [{"quantity": 1,
"sku": "com.xsolla.elven_sword_1"
},
{"quantity": 2,
"sku": "com.xsolla.elven_shield_1"
},
{"quantity": 2,
"sku": "com.xsolla.elven_gloves_1"
}
],
"date_end": "2020-04-25T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"external_id": "coupon_44056_1",
"is_enabled": true,
"name": {"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"redeem_code_limit": 1,
"redeem_total_limit": null,
"redeem_user_limit": null,
"total_limit_state": null
},
{"bonus": [{"quantity": 100,
"sku": "com.xsolla.diamonds_1"
}
],
"date_end": "2020-04-25T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"external_id": "summer2021",
"is_enabled": true,
"name": {"de-DE": "Gutscheintitel",
"en-US": "Coupon name"
},
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": null,
"total_limit_state": {"available": 50,
"reserved": 10,
"used": 40
}
}
],
"total_promotions_count": 2
}