List Coupons

GET {{baseUrl}}/coupons

This endpoint allows you to fetch a list of coupons.

OAuth Scopes

---

marketing.read

HEADERS

RESPONSES

status: OK

{"status":200,"success":true,"data":[{"id":815296212,"code":"AAVVC","type":"fixed","status":"active","amount":{"amount":9000,"currency":"SAR"},"minimum_amount":{"amount":22,"currency":"SAR"},"maximum_amount":{"amount":900,"currency":"SAR"},"show_maximum_amount":false,"expiry_date":"2022-01-26 00:00:00","free_shipping":true,"usage_limit":89,"usage_limit_per_user":88,"include_product_ids":["23390999"],"exclude_product_ids":["21819432"],"is_sale_products_exclude":true,"include_category_ids":["1364368","1364546"],"exclude_category_ids":["1187611"],"include_customer_group_ids":["7434"],"exclude_customer_group_ids":["7433"],"exclude_brands_ids":["49250"],"exclude_shipping_ids":["-14","-9","-7","-10","-3","-34","-32","-31","-13","129390","131750","133804","134744","134905","136502"],"include_customer_ids":[],"include_payment_methods":["apple_pay","bank","cod","credit_card","knet","mada","paypal","spotii_pay","stc_pay","tabby_installment","tamara_installment"],"applied_in":"all","is_group":true,"group_name":"Grouping","group_coupons_count":90,"group_coupon_suffix":null,"beneficiary_domain":"salla.sa","created_at":{"date":"2022-01-16 13:50:33.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"updated_at":{"date":"2022-01-16 14:08:09.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"marketing_active":true,"marketing_name":"Nabil","marketing_email":null,"marketing_type":"fixed","marketing_amount":{"amount":90,"currency":"SAR"},"marketing_hide_total_sales":false,"marketing_show_maximum_amount":true,"marketing_info":"","marketing_visits_count":0,"marketing_url":"https://mtjr.coupons/VvVMP"},{"id":318708448,"code":"ABCDEFG","type":"fixed","status":"inactive","amount":{"amount":30,"currency":"SAR"},"minimum_amount":{"amount":40,"currency":"SAR"},"maximum_amount":{"amount":0,"currency":"SAR"},"show_maximum_amount":true,"expiry_date":"2022-01-26 00:00:00","free_shipping":true,"usage_limit":3,"usage_limit_per_user":3,"include_product_ids":["21819432","23390999"],"exclude_product_ids":["1652376"],"is_sale_products_exclude":true,"include_category_ids":["1502214","1560103","1560107","1762868"],"exclude_category_ids":["745628","714007","1314843"],"include_customer_group_ids":["4191","4285"],"exclude_customer_group_ids":["3893"],"exclude_brands_ids":["103346","49250","115119","103341"],"exclude_shipping_ids":["-14","-9","-7","-10","-3","-34","-32","-31","-13","129390","131750","133804","134744","134905","136502"],"include_customer_ids":[],"include_payment_methods":["bank","cod","credit_card","knet","mada","paypal","spotii_pay","stc_pay","tabby_installment","tamara_installment","apple_pay"],"applied_in":"all","is_group":false,"group_name":null,"group_coupons_count":null,"group_coupon_suffix":null,"beneficiary_domain":"salla.sa","created_at":{"date":"2022-01-16 13:41:29.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"updated_at":{"date":"2022-01-16 14:12:45.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"marketing_active":true,"marketing_name":"Nabil","marketing_email":null,"marketing_type":"fixed","marketing_amount":{"amount":49,"currency":"SAR"},"marketing_hide_total_sales":false,"marketing_show_maximum_amount":false,"marketing_info":"Hello","marketing_visits_count":0,"marketing_url":"https://mtjr.coupons/FE7Ic"},{"id":1821187238,"code":"ZZZZXC","type":"fixed","status":"active","amount":{"amount":100,"currency":"SAR"},"minimum_amount":{"amount":100,"currency":"SAR"},"maximum_amount":{"amount":200,"currency":"SAR"},"show_maximum_amount":true,"expiry_date":"2022-12-31 00:00:00","free_shipping":true,"usage_limit":10,"usage_limit_per_user":3,"include_product_ids":[],"exclude_product_ids":[],"is_sale_products_exclude":true,"include_category_ids":["9831"],"exclude_category_ids":["8894"],"include_customer_group_ids":[],"exclude_customer_group_ids":[],"exclude_brands_ids":[],"exclude_shipping_ids":[],"include_customer_ids":[],"include_payment_methods":["bank","cod","credit_card","knet","mada","paypal","spotii_pay","stc_pay","tabby_installment","tamara_installment","apple_pay"],"applied_in":"all","is_group":false,"group_name":null,"group_coupons_count":null,"group_coupon_suffix":null,"beneficiary_domain":null,"created_at":{"date":"2022-01-16 13:36:14.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"updated_at":{"date":"2022-01-16 13:36:14.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"marketing_active":false,"marketing_name":null,"marketing_email":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}],"pagination":{"count":2,"total":2,"perPage":2,"currentPage":1,"totalPages":2,"links":{"next":"http://api.salla.dev/admin/v2/coupons?page=2"}}}