Create Coupon

POST {{baseUrl}}/coupons

This endpoint allows you to create Single Coupon, and Group Coupons.

:::note Although the response payload you will be receiving of the two coupon types at once, each has its own required Body Requests. :::

When creating a Single Coupon, ensure that you are sending the following required variables:

| Attribute               | Type    | Is Required |
| ----------------------- | ------- | ----------- |
| `code`                  | string  | Yes         |
| `type`                  | string  | Yes         |
| `amount`                | number  | Yes         |
| `free_shipping`         | boolean | Yes         |
| `expiry_date`           | string  | Yes         |
| `exclude_sale_products` | boolean | Yes         |

If `marketing_active` is valued as `true`, then when creating `Marketing Coupons`, ensure that you are sending the
following required variables:

| Attribute          | Type    | Is Required |
| ------------------ | ------- | ----------- |
| `marketing_active` | boolean | Yes         |
| `marketing_name`   | string  | Yes         |
| `marketing_type`   | string  | Yes         |
| `marketing_amount` | number  | Yes         |

If is_group is valued as true, then when creating Group Coupons, ensure that you are sending the following required variables:

| Attribute               | Type    | Is Required |
| ----------------------- | ------- | ----------- |
| `is_group`              | boolean | Yes         |
| `group_coupons_count`   | number  | Yes         |
| `group_suffix`          | string  | Yes         |
| `group_name`            | string  | Yes         |
| `type`                  | string  | Yes         |
| `amount`                | number  | Yes         |
| `free_shipping`         | boolean | Yes         |
| `expiry_date`           | string  | Yes         |
| `exclude_sale_products` | boolean | Yes         |

If `marketing_active` is valued as `true`, then when creating `Marketing Coupons`, ensure that you are sending the following required variables:

| Attribute          | Type    | Is Required |
| ------------------ | ------- | ----------- |
| `marketing_active` | boolean | Yes         |
| `marketing_name`   | string  | Yes         |
| `marketing_type`   | string  | Yes         |
| `marketing_amount` | number  | Yes         |

marketing.read_write- Marketing Read & Write

Request Body

{"code"=>"<string>", "type"=>"Percentage", "amount"=>"<number>", "status"=>"<string>", "start_date"=>"<dateTime>", "expiry_date"=>"<dateTime>", "applied_in"=>"all", "is_group"=>true, "group_name"=>"<string>", "group_coupons_count"=>"<integer>", "group_suffix"=>"<string>", "usage_limit"=>"<number>", "usage_limit_per_user"=>"<number>", "minimum_amount"=>"<number>", "maximum_amount"=>"<number>", "free_shipping"=>true, "exclude_sale_products"=>true, "show_maximum_amount"=>true, "marketing_show_maximum_amount"=>true, "marketing_active"=>true, "marketing_name"=>"<string>", "marketing_type"=>"F", "marketing_amount"=>"<number>", "marketing_hide_total_sales"=>true, "marketing_maximum_amount"=>"<number>", "marketing_info"=>"<string>", "beneficiary_domain"=>"<string>", "products_include"=>["<string>", "<string>"], "list_include_categories"=>["<string>", "<string>"], "products_exclude"=>["<string>", "<string>"], "list_exclude_categories"=>["<string>", "<string>"], "list_exclude_brands"=>["<string>", "<string>"], "list_include_groups"=>["<string>", "<string>"], "list_exclude_groups"=>["<string>", "<string>"], "list_exclude_shipping"=>["<string>", "<string>"], "payment_methods"=>["bank", "all"]}

HEADERS

RESPONSES

status: OK

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":{"id":"\u003cnumber\u003e","code":"\u003cstring\u003e","type":"f","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":["knet","stc_pay"],"applied_in":"app","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"}}