Coupon Details

GET {{baseUrl}}/coupons/:coupon_id

This endpoint allows you to fetch details regarding a coupon via its ID.

OAuth Scopes

---

marketing.read

HEADERS

RESPONSES

status: OK

{"status":200,"success":true,"data":{"id":1279613668,"code":"AAVVC","type":"fixed","status":"active","amount":{"amount":400,"currency":"SAR"},"minimum_amount":{"amount":40,"currency":"SAR"},"maximum_amount":{"amount":20,"currency":"SAR"},"show_maximum_amount":false,"expiry_date":"2022-01-31 00:00:00","free_shipping":true,"usage_limit":3,"usage_limit_per_user":3,"include_product_ids":["1350266755","1323637592"],"exclude_product_ids":["1607686509","1301156580"],"is_sale_products_exclude":true,"include_category_ids":["153068517","1253000609","779444866"],"exclude_category_ids":["1240558514","1647492286"],"include_customer_group_ids":["1923308056","304378284"],"exclude_customer_group_ids":["1179059377"],"exclude_brands_ids":["1283560901","894256587","1997920008"],"exclude_shipping_ids":["2079537577","989286562","1939592358"],"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":true,"group_name":"Coupon Group 1","group_coupons_count":90,"group_coupon_suffix":null,"beneficiary_domain":"domain.name","created_at":{"date":"2022-01-23 09:36:30.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"updated_at":{"date":"2022-01-23 09:37:39.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"marketing_active":true,"marketing_name":"User Name Marketer","marketing_type":"percentage","marketing_amount":{"amount":49,"currency":"SAR"},"marketing_hide_total_sales":false,"marketing_show_maximum_amount":true,"marketing_info":"AAA","marketing_visits_count":0,"marketing_url":"https://mtjr.coupons/W6naKKKAA"}}