# Discount coupons

Managing discount coupons in the e-shop.

## List of discount coupons

 - [GET /api/discount-coupons](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/getlistofdiscountcoupons.md): List of discount coupons within the e-shop. The list is paged at 1000 coupons. 
The discount coupons can be filtered according to the date of creation, validity, 
repeatability of usage or their template.


If absolute price is used, the amount is interpreted with the default
VAT rate of the eshop (in administration:


Settings » Basic Settings » Tax Classes). It can be retrieved using
endpoint Eshop Info, array .


The same is valid for minimum price.

## Discount coupons insertion

 - [POST /api/discount-coupons](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/creatediscountcoupons.md): This endpoint allows you to insert specific discount coupons into
Shoptet. Request is sent in JSON format in its body.


It is good to compare count of requested coupons with count of cooupons
in response as it can be different. It is because of request validation,
where it ignores invalid coupons.

## Bulk discount coupon deletion

 - [DELETE /api/discount-coupons](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/bulkdeletediscountcoupons.md): Bulk deletion of discount coupons as per list of . If successful, returns
the code 200.

If some discount coupons does not exist within the e-shop, a 422 code is
returned.

## List of all discount coupons

 - [GET /api/discount-coupons/snapshot](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/getlistofalldiscountcoupons.md): Using this endpoint, you can get list of all discount coupons with detailed info of each discount coupon 
asynchronously. See how Asynchronous requests 
work on our developer's portal.


Response will be in jsonlines format with each product taking one line of output file.
One discount coupon in response has the same format as one discount coupon item form list response.


Result file is compressed using GZIP.

## Detail of discount coupon

 - [GET /api/discount-coupons/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/getdetailofdiscountcoupon.md): Detail of discount coupon within the e-shop.

## Discount coupon deletion

 - [DELETE /api/discount-coupons/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/deletediscountcoupon.md): Deletes discount coupon as per entered . If successful, returns
the code 200.

If the discount coupon does not exist within the e-shop, a 404 code is
returned.

## Discount coupons set creation

 - [POST /api/discount-coupons/set](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/creatediscountcouponsset.md): This endpoint allows you to create set of discount coupons for Shoptet.It is good to compare count of requested
coupons with count of cooupons in response as it can be different. It is because of request validation, 
where it ignores invalid coupons.

## Discount coupons usage update

 - [PATCH /api/discount-coupons/use/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/updatediscountcouponsusage.md): This endpoint allows you to set usage of discount coupon.

## Templates of discount coupons

 - [GET /api/discount-coupons/templates](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/gettemplatesofdiscountcoupons.md): Templates of discount coupons within the e-shop. All templates are listed at a time. Without possibility of 
paging or filtering.

## Discount coupons template insertion

 - [POST /api/discount-coupons/templates](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/creatediscountcouponstemplate.md)

## Discount coupons template deletion

 - [DELETE /api/discount-coupons/templates/{guid}](https://api.docs.shoptet.com/shoptet-api/openapi/discount-coupons/deletediscountcouponstemplate.md): Deletes discount coupon template as per entered . If successful,
returns the code 200.

If the discount coupon template does not exist within the e-shop, a 404
code is returned.

If the discount coupon template cannot be deleted, because it is used as
template of discount coupon, a 409 code is returned.