> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # Create Discount Rule POST https://discounts/rules Content-Type: multipart/form-data Reference: https://docs.itspropel.com/propel-biz/15-discounts/discount-rules/create-discount-rule ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /discounts/rules: post: operationId: create-discount-rule summary: Create Discount Rule tags: - subpackage_15Discounts.subpackage_15Discounts/discountRules parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/15 Discounts_Discount Rules_Create Discount Rule_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: code: type: string description: 'Optional: Coupon code - max 100 chars - "SUMMER10"' name: type: string description: >- Required: Discount rule name - max 255 chars - "Summer Sale 10%" scope: type: string description: >- Optional: Discount scope - all_items|specific_items|specific_categories|specific_item_types status: type: string description: >- Optional: Rule status - active|inactive|expired - default active priority: type: string description: >- Optional: Priority when multiple apply - integer, min 0 - higher first valid_to: type: string description: >- Optional: Valid to date - YYYY-MM-DD, must be after valid_from valid_from: type: string description: 'Required: Valid from date - YYYY-MM-DD' description: type: string description: 'Optional: Rule description' is_stackable: type: string description: >- Optional: Can stack with other discounts - 0|1 - default false members_only: type: string description: 'Optional: Members only - 0|1 - default false' min_quantity: type: string description: 'Optional: Minimum quantity - numeric, min 0' discount_type: type: string description: 'Required: Discount type - percentage|fixed_amount|free_item' discount_value: type: string description: >- Required: Discount value - numeric, min 0 - "10" (10% or $10) max_total_uses: type: string description: 'Optional: Maximum total uses - integer, min 1 - "100"' first_time_only: type: string description: 'Optional: First-time customer only - 0|1 - default false' max_discount_amount: type: string description: 'Optional: Max discount cap - numeric, min 0 - "50"' min_purchase_amount: type: string description: 'Optional: Minimum purchase amount - numeric, min 0' max_uses_per_customer: type: string description: 'Optional: Max uses per customer - integer, min 1 - "1"' required: - code - name - scope - status - priority - valid_to - valid_from - description - is_stackable - members_only - min_quantity - discount_type - discount_value - max_total_uses - first_time_only - max_discount_amount - min_purchase_amount - max_uses_per_customer servers: - url: https:/ components: schemas: 15 Discounts_Discount Rules_Create Discount Rule_Response_200: type: object properties: {} description: Empty response body title: 15 Discounts_Discount Rules_Create Discount Rule_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/discounts/rules" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"code\"\r\n\r\nSUMMER10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nSummer Sale 10%\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scope\"\r\n\r\nall_items\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"status\"\r\n\r\nactive\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"priority\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_to\"\r\n\r\n2024-09-30\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_from\"\r\n\r\n2024-06-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n10% off on all items during summer sale\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_stackable\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"members_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_quantity\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_type\"\r\n\r\npercentage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_value\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_total_uses\"\r\n\r\n500\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_time_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_discount_amount\"\r\n\r\n50\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_purchase_amount\"\r\n\r\n20\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_uses_per_customer\"\r\n\r\n3\r\n-----011000010111000001101001--\r\n" headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "multipart/form-data; boundary=---011000010111000001101001" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/discounts/rules'; const form = new FormData(); form.append('code', 'SUMMER10'); form.append('name', 'Summer Sale 10%'); form.append('scope', 'all_items'); form.append('status', 'active'); form.append('priority', '10'); form.append('valid_to', '2024-09-30'); form.append('valid_from', '2024-06-01'); form.append('description', '10% off on all items during summer sale'); form.append('is_stackable', '1'); form.append('members_only', '0'); form.append('min_quantity', '1'); form.append('discount_type', 'percentage'); form.append('discount_value', '10'); form.append('max_total_uses', '500'); form.append('first_time_only', '0'); form.append('max_discount_amount', '50'); form.append('min_purchase_amount', '20'); form.append('max_uses_per_customer', '3'); const options = { method: 'POST', headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'} }; options.body = form; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/discounts/rules" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"code\"\r\n\r\nSUMMER10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nSummer Sale 10%\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scope\"\r\n\r\nall_items\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"status\"\r\n\r\nactive\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"priority\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_to\"\r\n\r\n2024-09-30\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_from\"\r\n\r\n2024-06-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n10% off on all items during summer sale\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_stackable\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"members_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_quantity\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_type\"\r\n\r\npercentage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_value\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_total_uses\"\r\n\r\n500\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_time_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_discount_amount\"\r\n\r\n50\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_purchase_amount\"\r\n\r\n20\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_uses_per_customer\"\r\n\r\n3\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/discounts/rules") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"code\"\r\n\r\nSUMMER10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nSummer Sale 10%\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scope\"\r\n\r\nall_items\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"status\"\r\n\r\nactive\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"priority\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_to\"\r\n\r\n2024-09-30\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_from\"\r\n\r\n2024-06-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n10% off on all items during summer sale\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_stackable\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"members_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_quantity\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_type\"\r\n\r\npercentage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_value\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_total_uses\"\r\n\r\n500\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_time_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_discount_amount\"\r\n\r\n50\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_purchase_amount\"\r\n\r\n20\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_uses_per_customer\"\r\n\r\n3\r\n-----011000010111000001101001--\r\n" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/discounts/rules") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"code\"\r\n\r\nSUMMER10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nSummer Sale 10%\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scope\"\r\n\r\nall_items\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"status\"\r\n\r\nactive\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"priority\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_to\"\r\n\r\n2024-09-30\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_from\"\r\n\r\n2024-06-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n10% off on all items during summer sale\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_stackable\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"members_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_quantity\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_type\"\r\n\r\npercentage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_value\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_total_uses\"\r\n\r\n500\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_time_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_discount_amount\"\r\n\r\n50\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_purchase_amount\"\r\n\r\n20\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_uses_per_customer\"\r\n\r\n3\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/discounts/rules', [ 'multipart' => [ [ 'name' => 'code', 'contents' => 'SUMMER10' ], [ 'name' => 'name', 'contents' => 'Summer Sale 10%' ], [ 'name' => 'scope', 'contents' => 'all_items' ], [ 'name' => 'status', 'contents' => 'active' ], [ 'name' => 'priority', 'contents' => '10' ], [ 'name' => 'valid_to', 'contents' => '2024-09-30' ], [ 'name' => 'valid_from', 'contents' => '2024-06-01' ], [ 'name' => 'description', 'contents' => '10% off on all items during summer sale' ], [ 'name' => 'is_stackable', 'contents' => '1' ], [ 'name' => 'members_only', 'contents' => '0' ], [ 'name' => 'min_quantity', 'contents' => '1' ], [ 'name' => 'discount_type', 'contents' => 'percentage' ], [ 'name' => 'discount_value', 'contents' => '10' ], [ 'name' => 'max_total_uses', 'contents' => '500' ], [ 'name' => 'first_time_only', 'contents' => '0' ], [ 'name' => 'max_discount_amount', 'contents' => '50' ], [ 'name' => 'min_purchase_amount', 'contents' => '20' ], [ 'name' => 'max_uses_per_customer', 'contents' => '3' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/discounts/rules"); var request = new RestRequest(Method.POST); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"code\"\r\n\r\nSUMMER10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nSummer Sale 10%\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scope\"\r\n\r\nall_items\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"status\"\r\n\r\nactive\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"priority\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_to\"\r\n\r\n2024-09-30\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_from\"\r\n\r\n2024-06-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n10% off on all items during summer sale\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_stackable\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"members_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_quantity\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_type\"\r\n\r\npercentage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"discount_value\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_total_uses\"\r\n\r\n500\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_time_only\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_discount_amount\"\r\n\r\n50\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"min_purchase_amount\"\r\n\r\n20\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"max_uses_per_customer\"\r\n\r\n3\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"] let parameters = [ [ "name": "code", "value": "SUMMER10" ], [ "name": "name", "value": "Summer Sale 10%" ], [ "name": "scope", "value": "all_items" ], [ "name": "status", "value": "active" ], [ "name": "priority", "value": "10" ], [ "name": "valid_to", "value": "2024-09-30" ], [ "name": "valid_from", "value": "2024-06-01" ], [ "name": "description", "value": "10% off on all items during summer sale" ], [ "name": "is_stackable", "value": "1" ], [ "name": "members_only", "value": "0" ], [ "name": "min_quantity", "value": "1" ], [ "name": "discount_type", "value": "percentage" ], [ "name": "discount_value", "value": "10" ], [ "name": "max_total_uses", "value": "500" ], [ "name": "first_time_only", "value": "0" ], [ "name": "max_discount_amount", "value": "50" ], [ "name": "min_purchase_amount", "value": "20" ], [ "name": "max_uses_per_customer", "value": "3" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://https/discounts/rules")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```