Authorization
Where to begin? Tools Statistics Purses and withdrawal of money Why did not the order be credited? Documentation API
Coupons

Coupons

Receiving the coupon list (Get-Coupons)

Description
Method for getting the coupon list.
Link to the method in Swagger
Format
https://app.epn.bz/coupons?limit=<int>&offset=<int>&isPersonal=<boolean>&viewRules=<string> 
Entry parameters
Header Parameters
Name Description Possible values Required
X-ACCESS-TOKEN access token should be transmitted Yes
ACCEPT-LANGUAGE locale for which the coupons will be ru, en, es Yes
Query Parameters
Name Description Type Possible values Required
isPersonal parameter that will return only exclusive coupons, i.e. those coupons that are available only for your account boolean true false No
viewRules Parameter that determines what kind of offers will come in the answer: offers for the webmaster account or for cashback account. string role_cashback - is to receive cashback coupons.
role_user - is to receive coupons for the webmaster account
Not (if the parameter access token is transmitted)
typeId coupon type id. Integer identifier. When this parameter is transmitted, the coupons of the specified type will be returned.
If the parameter is not specified, the coupons of all types will be returned.
int No
themeId id of coupon subject. Integer identifier. When this parameter is transmitted, the coupons of the specified subject will return. int No
offerId offer id. Integer identifier. When this parameter is transmitted, the coupons of the specified offer will be returned. int No
limit number of elements on the page. int Yes
offset offset int Yes
Response
Name Description Required
Code Coupon code (promotional code). When making purchases, this code must be entered on the store’s website to receive a discount. It can be absent if this is a general discount. No
isPersonal This is a note that the coupon is exclusive, i.e. it’s only for your account. No
userId It needs to fill it in if the coupon is personal. In this case, your id will be returned to the field. No
themeId subject id to which the coupon belongs. Subject list Yes
offerId offer id to which the coupon belongs. Yes
dateFrom start of the coupon validation: date and time. Yes
dateTo end of the coupon validation: date and time. Yes
typeId type id to which the coupon belongs. Coupon type list Yes
url offer page to which the coupon leads. Yes
name name of the coupon. Yes
description Description of the coupon. Additional terms. Description may be absent. No

Receiving the list of offers with coupons

Description
Method for getting the list of offers (stores) that have coupons.
Link to the method in Swagger
Format
https://app.epn.bz/coupons/offers?viewRules=<string>
Entry parameters
Header Parameters
Name Description Required
X-ACCESS-TOKEN access token should be transmitted Yes
Query Parameters
Name Description Possible values Required
viewRules Parameter that determines what kind of offers will come in the answer: offers for the webmaster account or for cashback account. role_cashback - is to receive cashback coupons.
role_user - is to receive coupons for the webmaster account
Not (if the parameter access token is transmitted)

Receiving the list of coupon types (Get-Coupons-Types)

Description
The method will return the list of coupon types. One coupon can only belong to one type.
Link to the method in Swagger
Format
https://app.epn.bz/coupons/types
Entry parameters
Header Parameters
Name Description Required
X-ACCESS-TOKEN access token should be transmitted Yes
Coupon type list
Type identifier (id) Name Description type
10 Discount for the order Discount when making an order of a certain amount value.
Example: Discount 500 rub for the order from the value of 5000 rub
11 Gift for the order A gift when placing an order of a certain amount value.
Example: a cosmetic bag as a gift when the order amount is more than 3,000 rub in the Letual store.
12 Free delivery Free delivery if certain purchase conditions are fulfilled
Example: free delivery when the order amount is more than 5 000 rub

Receiving the list of coupon subjects

Description
The method returns the subject list for coupons.
Link to the method in Swagger
Header Parameters
Name Type Possible values Description

ACCEPT-LANGUAGE

string ru
en
es
Language in which the subject list for coupons will return.
Subject list
Type identifier (id) Name
10 Black Friday -Coupons for Black Friday
11 New Year - Coupons for New Year
12 the 23rd of February - coupons for the 23rd of February
13 the 8th of March - coupons for the 8th of March
14 Cyber Monday - Coupons for Cyber Monday
15 Back to school - Coupons for the 1st of September and the beginning of the school year.
16 11.11 - Coupons for Worldwide Shopping Day sale on the 11th of November on AliExpress
17 sale - general theme for discount coupons.
18 February 14th - Coupons for the 14th of February