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":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}}