Discounts
Update Discount
Update the details of an existing discount identified by its ID. Allows modification of various fields including name, code, discount_type, and more. Requires x-store-id for authorization. Returns the updated discount data.
PATCH
/
v1
/
discounts
/
{id}
Update Discount
curl --request PATCH \
--url https://api.blink.store/v1/v1/discounts/{id} \
--header 'Content-Type: application/json' \
--header 'x-store-id: <api-key>' \
--data '
{
"name": "<string>",
"code": "<string>",
"discount_type": "<string>",
"discount_amount": 123,
"status": "<string>",
"max_redemptions": 123,
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"product_ids": [
"<string>"
]
}
'import requests
url = "https://api.blink.store/v1/v1/discounts/{id}"
payload = {
"name": "<string>",
"code": "<string>",
"discount_type": "<string>",
"discount_amount": 123,
"status": "<string>",
"max_redemptions": 123,
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"product_ids": ["<string>"]
}
headers = {
"x-store-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-store-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
code: '<string>',
discount_type: '<string>',
discount_amount: 123,
status: '<string>',
max_redemptions: 123,
starts_at: '2023-11-07T05:31:56Z',
expires_at: '2023-11-07T05:31:56Z',
product_ids: ['<string>']
})
};
fetch('https://api.blink.store/v1/v1/discounts/{id}', 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.blink.store/v1/v1/discounts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'code' => '<string>',
'discount_type' => '<string>',
'discount_amount' => 123,
'status' => '<string>',
'max_redemptions' => 123,
'starts_at' => '2023-11-07T05:31:56Z',
'expires_at' => '2023-11-07T05:31:56Z',
'product_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-store-id: <api-key>"
],
]);
$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.blink.store/v1/v1/discounts/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"discount_amount\": 123,\n \"status\": \"<string>\",\n \"max_redemptions\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"product_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-store-id", "<api-key>")
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.patch("https://api.blink.store/v1/v1/discounts/{id}")
.header("x-store-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"discount_amount\": 123,\n \"status\": \"<string>\",\n \"max_redemptions\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"product_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blink.store/v1/v1/discounts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-store-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"discount_amount\": 123,\n \"status\": \"<string>\",\n \"max_redemptions\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"product_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"discount_type": "<string>",
"discount_amount": 123,
"status": "<string>",
"max_redemptions": 123,
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"product_ids": [
"<string>"
]
}Authorizations
Path Parameters
ID of the discount.
Body
application/json
Previous
List DiscountsFetch a paginated list of all discounts available within a store using `x-store-id`. Supports filtering by `status` and includes pagination via `limit`, `page`, and `offset`. Returns discount details such as codes, types, and amounts.
Next
⌘I
Update Discount
curl --request PATCH \
--url https://api.blink.store/v1/v1/discounts/{id} \
--header 'Content-Type: application/json' \
--header 'x-store-id: <api-key>' \
--data '
{
"name": "<string>",
"code": "<string>",
"discount_type": "<string>",
"discount_amount": 123,
"status": "<string>",
"max_redemptions": 123,
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"product_ids": [
"<string>"
]
}
'import requests
url = "https://api.blink.store/v1/v1/discounts/{id}"
payload = {
"name": "<string>",
"code": "<string>",
"discount_type": "<string>",
"discount_amount": 123,
"status": "<string>",
"max_redemptions": 123,
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"product_ids": ["<string>"]
}
headers = {
"x-store-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-store-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
code: '<string>',
discount_type: '<string>',
discount_amount: 123,
status: '<string>',
max_redemptions: 123,
starts_at: '2023-11-07T05:31:56Z',
expires_at: '2023-11-07T05:31:56Z',
product_ids: ['<string>']
})
};
fetch('https://api.blink.store/v1/v1/discounts/{id}', 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.blink.store/v1/v1/discounts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'code' => '<string>',
'discount_type' => '<string>',
'discount_amount' => 123,
'status' => '<string>',
'max_redemptions' => 123,
'starts_at' => '2023-11-07T05:31:56Z',
'expires_at' => '2023-11-07T05:31:56Z',
'product_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-store-id: <api-key>"
],
]);
$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.blink.store/v1/v1/discounts/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"discount_amount\": 123,\n \"status\": \"<string>\",\n \"max_redemptions\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"product_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-store-id", "<api-key>")
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.patch("https://api.blink.store/v1/v1/discounts/{id}")
.header("x-store-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"discount_amount\": 123,\n \"status\": \"<string>\",\n \"max_redemptions\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"product_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blink.store/v1/v1/discounts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-store-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"discount_amount\": 123,\n \"status\": \"<string>\",\n \"max_redemptions\": 123,\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"product_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"discount_type": "<string>",
"discount_amount": 123,
"status": "<string>",
"max_redemptions": 123,
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"product_ids": [
"<string>"
]
}