List Coupons

GET {{baseUrl}}/coupons

This endpoint allows you to fetch a list of coupons.

Scope: marketing.read- Marketing Read Only

HEADERS

RESPONSES

status: OK

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":[{"id":"\u003cnumber\u003e","code":"\u003cstring\u003e","type":"Fixed","status":"active","amount":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"minimum_amount":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"maximum_amount":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"show_maximum_amount":false,"expiry_date":"\u003cstring\u003e","start_date":"\u003cstring\u003e","free_shipping":true,"usage_limit":"\u003cnumber\u003e","usage_limit_per_user":"\u003cnumber\u003e","include_product_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_product_ids":["\u003cstring\u003e","\u003cstring\u003e"],"is_sale_products_exclude":true,"include_category_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_category_ids":["\u003cstring\u003e","\u003cstring\u003e"],"include_customer_group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_customer_group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_brands_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_shipping_ids":["\u003cstring\u003e","\u003cstring\u003e"],"include_customer_ids":["\u003cstring\u003e","\u003cstring\u003e"],"include_payment_methods":["tabby_installment","cod"],"applied_in":"web","is_group":true,"group_name":"\u003cstring\u003e","group_coupons_count":"\u003cnumber\u003e","group_coupon_suffix":"\u003cstring\u003e","group_coupons":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}],"beneficiary_domain":"\u003cstring\u003e","statistics":{"num_of_usage":"\u003cnumber\u003e","num_of_customers":"\u003cnumber\u003e","coupon_sales":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"}},"created_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"updated_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"marketing_active":true,"marketing_name":"\u003cstring\u003e","marketing_email":"\u003cstring\u003e","marketing_type":"percentage","marketing_amount":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"marketing_hide_total_sales":false,"marketing_show_maximum_amount":true,"marketing_maximum_amount":0,"marketing_info":"\u003cstring\u003e","marketing_visits_count":"\u003cnumber\u003e","marketing_url":"\u003cstring\u003e","marketing_statistics_url":"\u003cstring\u003e"},{"id":"\u003cnumber\u003e","code":"\u003cstring\u003e","type":"P","status":"inactive","amount":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"minimum_amount":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"maximum_amount":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"show_maximum_amount":false,"expiry_date":"\u003cstring\u003e","start_date":"\u003cstring\u003e","free_shipping":true,"usage_limit":"\u003cnumber\u003e","usage_limit_per_user":"\u003cnumber\u003e","include_product_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_product_ids":["\u003cstring\u003e","\u003cstring\u003e"],"is_sale_products_exclude":true,"include_category_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_category_ids":["\u003cstring\u003e","\u003cstring\u003e"],"include_customer_group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_customer_group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_brands_ids":["\u003cstring\u003e","\u003cstring\u003e"],"exclude_shipping_ids":["\u003cstring\u003e","\u003cstring\u003e"],"include_customer_ids":["\u003cstring\u003e","\u003cstring\u003e"],"include_payment_methods":["mada","cod"],"applied_in":"web","is_group":true,"group_name":"\u003cstring\u003e","group_coupons_count":"\u003cnumber\u003e","group_coupon_suffix":"\u003cstring\u003e","group_coupons":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}],"beneficiary_domain":"\u003cstring\u003e","statistics":{"num_of_usage":"\u003cnumber\u003e","num_of_customers":"\u003cnumber\u003e","coupon_sales":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"}},"created_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"updated_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"marketing_active":true,"marketing_name":"\u003cstring\u003e","marketing_email":"\u003cstring\u003e","marketing_type":"P","marketing_amount":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"marketing_hide_total_sales":false,"marketing_show_maximum_amount":true,"marketing_maximum_amount":0,"marketing_info":"\u003cstring\u003e","marketing_visits_count":"\u003cnumber\u003e","marketing_url":"\u003cstring\u003e","marketing_statistics_url":"\u003cstring\u003e"}],"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}}