Create Discount
curl --request POST \
--url https://api.headlesscommerce.io/v1/admin/discounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"value": 123,
"description": "<string>",
"code": "<string>",
"target": "order",
"usage_limit": 123,
"per_customer_limit": 123,
"minimum_amount": 123,
"maximum_discount": 123,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"conditions": [
{
"values": [
"<string>"
],
"operator": "in"
}
],
"metadata": {}
}
'import requests
url = "https://api.headlesscommerce.io/v1/admin/discounts"
payload = {
"name": "<string>",
"value": 123,
"description": "<string>",
"code": "<string>",
"target": "order",
"usage_limit": 123,
"per_customer_limit": 123,
"minimum_amount": 123,
"maximum_discount": 123,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"conditions": [
{
"values": ["<string>"],
"operator": "in"
}
],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
value: 123,
description: '<string>',
code: '<string>',
target: 'order',
usage_limit: 123,
per_customer_limit: 123,
minimum_amount: 123,
maximum_discount: 123,
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z',
conditions: [{values: ['<string>'], operator: 'in'}],
metadata: {}
})
};
fetch('https://api.headlesscommerce.io/v1/admin/discounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.headlesscommerce.io/v1/admin/discounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'value' => 123,
'description' => '<string>',
'code' => '<string>',
'target' => 'order',
'usage_limit' => 123,
'per_customer_limit' => 123,
'minimum_amount' => 123,
'maximum_discount' => 123,
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z',
'conditions' => [
[
'values' => [
'<string>'
],
'operator' => 'in'
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.headlesscommerce.io/v1/admin/discounts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"value\": 123,\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"target\": \"order\",\n \"usage_limit\": 123,\n \"per_customer_limit\": 123,\n \"minimum_amount\": 123,\n \"maximum_discount\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"conditions\": [\n {\n \"values\": [\n \"<string>\"\n ],\n \"operator\": \"in\"\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.headlesscommerce.io/v1/admin/discounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"value\": 123,\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"target\": \"order\",\n \"usage_limit\": 123,\n \"per_customer_limit\": 123,\n \"minimum_amount\": 123,\n \"maximum_discount\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"conditions\": [\n {\n \"values\": [\n \"<string>\"\n ],\n \"operator\": \"in\"\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.headlesscommerce.io/v1/admin/discounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"value\": 123,\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"target\": \"order\",\n \"usage_limit\": 123,\n \"per_customer_limit\": 123,\n \"minimum_amount\": 123,\n \"maximum_discount\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"conditions\": [\n {\n \"values\": [\n \"<string>\"\n ],\n \"operator\": \"in\"\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"code": "<string>",
"type": "code",
"value_type": "fixed",
"value": 123,
"target": "order",
"usage_limit": 123,
"usage_count": 123,
"per_customer_limit": 123,
"minimum_amount": {
"amount": 123,
"currency": "<string>"
},
"maximum_discount": {
"amount": 123,
"currency": "<string>"
},
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"is_active": true,
"conditions": [
{
"id": "<string>",
"type": "product",
"operator": "in",
"values": [
"<string>"
]
}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z"
}Admin - Discounts
Create Discount
POST
/
admin
/
discounts
Create Discount
curl --request POST \
--url https://api.headlesscommerce.io/v1/admin/discounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"value": 123,
"description": "<string>",
"code": "<string>",
"target": "order",
"usage_limit": 123,
"per_customer_limit": 123,
"minimum_amount": 123,
"maximum_discount": 123,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"conditions": [
{
"values": [
"<string>"
],
"operator": "in"
}
],
"metadata": {}
}
'import requests
url = "https://api.headlesscommerce.io/v1/admin/discounts"
payload = {
"name": "<string>",
"value": 123,
"description": "<string>",
"code": "<string>",
"target": "order",
"usage_limit": 123,
"per_customer_limit": 123,
"minimum_amount": 123,
"maximum_discount": 123,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"conditions": [
{
"values": ["<string>"],
"operator": "in"
}
],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
value: 123,
description: '<string>',
code: '<string>',
target: 'order',
usage_limit: 123,
per_customer_limit: 123,
minimum_amount: 123,
maximum_discount: 123,
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z',
conditions: [{values: ['<string>'], operator: 'in'}],
metadata: {}
})
};
fetch('https://api.headlesscommerce.io/v1/admin/discounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.headlesscommerce.io/v1/admin/discounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'value' => 123,
'description' => '<string>',
'code' => '<string>',
'target' => 'order',
'usage_limit' => 123,
'per_customer_limit' => 123,
'minimum_amount' => 123,
'maximum_discount' => 123,
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z',
'conditions' => [
[
'values' => [
'<string>'
],
'operator' => 'in'
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.headlesscommerce.io/v1/admin/discounts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"value\": 123,\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"target\": \"order\",\n \"usage_limit\": 123,\n \"per_customer_limit\": 123,\n \"minimum_amount\": 123,\n \"maximum_discount\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"conditions\": [\n {\n \"values\": [\n \"<string>\"\n ],\n \"operator\": \"in\"\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.headlesscommerce.io/v1/admin/discounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"value\": 123,\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"target\": \"order\",\n \"usage_limit\": 123,\n \"per_customer_limit\": 123,\n \"minimum_amount\": 123,\n \"maximum_discount\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"conditions\": [\n {\n \"values\": [\n \"<string>\"\n ],\n \"operator\": \"in\"\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.headlesscommerce.io/v1/admin/discounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"value\": 123,\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"target\": \"order\",\n \"usage_limit\": 123,\n \"per_customer_limit\": 123,\n \"minimum_amount\": 123,\n \"maximum_discount\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"conditions\": [\n {\n \"values\": [\n \"<string>\"\n ],\n \"operator\": \"in\"\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"code": "<string>",
"type": "code",
"value_type": "fixed",
"value": 123,
"target": "order",
"usage_limit": 123,
"usage_count": 123,
"per_customer_limit": 123,
"minimum_amount": {
"amount": 123,
"currency": "<string>"
},
"maximum_discount": {
"amount": 123,
"currency": "<string>"
},
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"is_active": true,
"conditions": [
{
"id": "<string>",
"type": "product",
"operator": "in",
"values": [
"<string>"
]
}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z"
}Authorizations
API Key. Example: sk_live_xxxxx or pk_live_xxxxx
Body
application/json
Available options:
code, automatic Available options:
fixed, percentage, free_shipping Available options:
order, line_item, shipping Show child attributes
Show child attributes
Response
201 - application/json
Created
Available options:
code, automatic Available options:
fixed, percentage, free_shipping Available options:
order, line_item, shipping Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I