URL
GET
/api/v1/vouchers/list
Parameters
Name |
Type |
Method |
Required |
Default |
Description |
page |
int |
GET |
no |
1 |
Stránkovanie. |
Response
HTTP 200 - OK
Host: example.org
Content-Type: application/vnd.shoptec.v1.0+json; charset=utf-8
{
"page": 1,
"pages": 1,
"itemsCount": 1,
"itemsPerPage": 10,
"vouchers": [
{
"id": 1,
"code": "XAGNACZG",
"value": "10",
"value_vat": "20",
"value_percentage": "1",
"min_sum": "200",
"combinable": "1",
"free_shipping": "0",
"free_payment": "0",
"usage_limit": "5",
"enabled": "1",
"expiration": "2022-12-31 00:00:00",
"products": [],
"customer_id": null
}
]
}
URL
POST
/api/v1/vouchers/create
Parameters
Name |
Type |
Method |
Required |
Default |
Description |
code |
string |
POST |
yes |
|
Kód kupónu (max. 30 znakov). |
value |
float |
POST |
yes |
|
Výška zľavy. |
value_vat |
int |
POST |
no |
20 |
Výška DPH v %. |
value_percentage |
bool |
POST |
yes |
|
Príznak, či výška zľavy "value" je v percentách alebo ide o fixnú výšku zľavy. |
min_sum |
float |
POST |
no |
0 |
Minimálna výška nákupu. |
combinable |
bool |
POST |
no |
1 |
Príznak, či sa má zľavový kupón vzťahovať aj na už zľavnené produkty. |
free_shipping |
bool |
POST |
no |
0 |
Kupón poskytne dopravu zadarmo. |
free_payment |
bool |
POST |
no |
0 |
Kupón poskytne platbu zadarmo (napr. dobierka bude 0 EUR, pokiaľ má nastavenú cenu). |
usage_limit |
int |
POST |
no |
|
Max. počet použití. Pokiaľ necháte prázdne, kupón je možné použiť bez obmedzenia. |
enabled |
bool |
POST |
no |
1 |
Zapnutie/Vypnutie kupónu. |
expiration |
string |
POST |
yes |
|
Dátum exspirácie kupónu. Je možné použiť akýkoľvek formát PHP funkcie strtotime(). |
products |
int[] |
POST |
no |
|
ID produktov, na ktoré sa majú zľavové kupóny viazať. Pokiaľ nie je definovaná žiadna množina, kupóny platia na všetky produkty. |
customer_id |
int |
POST |
no |
|
Obmedzenie kupónu len na konkrétneho registrovaného a prihláseného zákazníka. |
Request
{
"code": "XAGNACZG",
"value": "10",
"value_vat": "20",
"value_percentage": "1",
"min_sum": "200",
"combinable": "1",
"free_shipping": "0",
"free_payment": "0",
"usage_limit": "5",
"enabled": "1",
"expiration": "2022-12-31 00:00:00",
"products": [],
"customer_id": null
}
Response
HTTP 201 - Created
Host: example.org
Content-Type: application/vnd.shoptec.v1.0+json; charset=utf-8
{
"voucher": {
"id": 1,
"code": "XAGNACZG",
"value": "10",
"value_vat": "20",
"value_percentage": "1",
"min_sum": "200",
"combinable": "1",
"free_shipping": "0",
"free_payment": "0",
"usage_limit": "5",
"enabled": "1",
"expiration": "2022-12-31 00:00:00",
"products": [],
"customer_id": null
}
}
URL
PATCH
/api/v1/vouchers/update
Parameters
Name |
Type |
Method |
Required |
Default |
Description |
id |
int |
GET |
yes |
|
ID zľavového kupónu. |
code |
string |
POST |
no |
|
Kód kupónu (max. 30 znakov). |
value |
float |
POST |
no |
|
Výška zľavy. |
value_vat |
int |
POST |
no |
20 |
Výška DPH v %. |
value_percentage |
bool |
POST |
no |
|
Príznak, či výška zľavy "value" je v percentách alebo ide o fixnú výšku zľavy. |
min_sum |
float |
POST |
no |
0 |
Minimálna výška nákupu. |
combinable |
bool |
POST |
no |
1 |
Príznak, či sa má zľavový kupón vzťahovať aj na už zľavnené produkty. |
free_shipping |
bool |
POST |
no |
0 |
Kupón poskytne dopravu zadarmo. |
free_payment |
bool |
POST |
no |
0 |
Kupón poskytne platbu zadarmo (napr. dobierka bude 0 EUR, pokiaľ má nastavenú cenu). |
usage_limit |
int |
POST |
no |
|
Max. počet použití. Pokiaľ necháte prázdne, kupón je možné použiť bez obmedzenia. |
enabled |
bool |
POST |
no |
1 |
Zapnutie/Vypnutie kupónu. |
expiration |
string |
POST |
no |
|
Dátum exspirácie kupónu. Je možné použiť akýkoľvek formát PHP funkcie strtotime(). |
products |
int[] |
POST |
no |
|
ID produktov, na ktoré sa majú zľavové kupóny viazať. Pokiaľ nie je definovaná žiadna množina, kupóny platia na všetky produkty. |
customer_id |
int |
POST |
no |
|
Obmedzenie kupónu len na konkrétneho registrovaného a prihláseného zákazníka. |
Response
HTTP 204 - No Content
Host: example.org
Content-Type: application/vnd.shoptec.v1.0+json; charset=utf-8
URL
DELETE
/api/v1/vouchers/delete
Parameters
Name |
Type |
Method |
Required |
Default |
Description |
id |
int |
GET |
yes |
|
ID zľavového kupónu. |
Response
HTTP 204 - No Content
Host: example.org
Content-Type: application/vnd.shoptec.v1.0+json; charset=utf-8
URL
GET
/api/v1/vouchers/count
Response
HTTP 200 - OK
Host: example.org
Content-Type: application/vnd.shoptec.v1.0+json; charset=utf-8
{
"count": 125
}