List Coupons

GET {{baseUrl}}/coupons

This endpoint allows you to fetch a list of coupons.

HEADERS

RESPONSES

status: OK

{"status":200,"success":true,"data":[{"id":6930446,"code":"DEAL","type":"fixed","status":"active","amount":{"amount":30,"currency":"SAR"},"minimum_amount":null,"maximum_amount":{"amount":0,"currency":"SAR"},"show_maximum_amount":false,"expiry_date":"2023-03-17 00:00:00","start_date":null,"free_shipping":true,"usage_limit":null,"usage_limit_per_user":null,"include_product_ids":[],"exclude_product_ids":[],"is_sale_products_exclude":true,"include_category_ids":[],"exclude_category_ids":[],"include_customer_group_ids":[],"exclude_customer_group_ids":[],"exclude_brands_ids":[],"exclude_shipping_ids":[],"include_payment_methods":[],"applied_in":"all","is_group":true,"group_name":"Deals","group_coupons_count":3,"group_coupon_suffix":"DEAL","group_coupons":[{"code":"DEAL5Wsl"},{"code":"DEALgaNN"},{"code":"DEALFRa7"}],"beneficiary_domain":null,"statistics":{"num_of_usage":0,"num_of_customers":0,"coupon_sales":{"amount":0,"currency":"SAR"}},"created_at":{"date":"2022-04-06 12:55:06.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"updated_at":{"date":"2022-04-06 12:55:06.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"marketing_active":false,"marketing_name":null,"marketing_type":null,"marketing_amount":null,"marketing_hide_total_sales":false,"marketing_show_maximum_amount":false,"marketing_maximum_amount":null,"marketing_info":null,"marketing_visits_count":null,"marketing_url":null,"marketing_statistics_url":null},{"id":1622617640,"code":"QAZCVS","type":"fixed","status":"active","amount":{"amount":30,"currency":"SAR"},"minimum_amount":null,"maximum_amount":{"amount":0,"currency":"SAR"},"show_maximum_amount":false,"expiry_date":"2023-03-17 00:00:00","start_date":null,"free_shipping":true,"usage_limit":null,"usage_limit_per_user":null,"include_product_ids":[],"exclude_product_ids":[],"is_sale_products_exclude":true,"include_category_ids":[],"exclude_category_ids":[],"include_customer_group_ids":[],"exclude_customer_group_ids":[],"exclude_brands_ids":[],"exclude_shipping_ids":[],"include_payment_methods":[],"applied_in":"all","is_group":false,"group_name":null,"group_coupons_count":null,"group_coupon_suffix":null,"group_coupons":null,"beneficiary_domain":null,"statistics":{"num_of_usage":0,"num_of_customers":0,"coupon_sales":{"amount":0,"currency":"SAR"}},"created_at":{"date":"2022-04-06 12:45:13.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"updated_at":{"date":"2022-04-06 12:45:13.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"marketing_active":true,"marketing_name":"Nabil","marketing_type":"percentage","marketing_amount":{"amount":10,"currency":"SAR"},"marketing_hide_total_sales":false,"marketing_show_maximum_amount":false,"marketing_info":"","marketing_visits_count":0,"marketing_url":"https://salla.sa/dev-wofftr4xsra5xtlv?utm_source=ref\u0026utm_campaign=QAZCVS","marketing_statistics_url":"https://mtjr.coupons/w172T"},{"id":242399780,"code":"azvfpsv","type":"fixed","status":"active","amount":{"amount":30,"currency":"SAR"},"minimum_amount":{"amount":100,"currency":"SAR"},"maximum_amount":{"amount":50,"currency":"SAR"},"show_maximum_amount":false,"expiry_date":"2023-03-17 00:00:00","start_date":"2022-04-24 06:00:00","free_shipping":true,"usage_limit":10,"usage_limit_per_user":1,"include_product_ids":[1261174103],"exclude_product_ids":[277818017],"is_sale_products_exclude":true,"include_category_ids":[256950451,2064430530],"exclude_category_ids":[307036893],"include_customer_group_ids":[667738032],"exclude_customer_group_ids":[],"exclude_brands_ids":[1097509908],"exclude_shipping_ids":[1935030040],"include_payment_methods":["all"],"applied_in":"all","is_group":false,"group_name":null,"group_coupons_count":null,"group_coupon_suffix":null,"group_coupons":null,"beneficiary_domain":"salla.sa","statistics":{"num_of_usage":0,"num_of_customers":0,"coupon_sales":{"amount":0,"currency":"SAR"}},"created_at":{"date":"2022-04-06 12:38:06.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"updated_at":{"date":"2022-04-06 12:59:14.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"marketing_active":true,"marketing_name":"User Name","marketing_type":"percentage","marketing_amount":{"amount":5,"currency":"SAR"},"marketing_hide_total_sales":false,"marketing_show_maximum_amount":true,"marketing_maximum_amount":4000,"marketing_info":"Marketing coupon for User Name","marketing_visits_count":0,"marketing_url":"https://salla.sa/dev-wofftr4xsra5xtlv?utm_source=ref\u0026utm_campaign=azvfpsv","marketing_statistics_url":"https://mtjr.coupons/eqOuz"}],"pagination":{"count":3,"total":3,"perPage":15,"currentPage":1,"totalPages":1,"links":[]}}