Skip to main content
POST
/
bitlogin
/
api
/
open
/
v1
/
loyalty
/
reward-options
Create reward option
curl --request POST \
  --url https://api.bitbybit.studio/bitlogin/api/open/v1/loyalty/reward-options \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "rewardName": "<string>",
  "costToRedeem": 2,
  "discountValue": "<string>",
  "voucherPrefix": "<string>",
  "minimumPurchaseAmount": "<string>"
}
'
import requests

url = "https://api.bitbybit.studio/bitlogin/api/open/v1/loyalty/reward-options"

payload = {
"rewardName": "<string>",
"costToRedeem": 2,
"discountValue": "<string>",
"voucherPrefix": "<string>",
"minimumPurchaseAmount": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rewardName: '<string>',
costToRedeem: 2,
discountValue: '<string>',
voucherPrefix: '<string>',
minimumPurchaseAmount: '<string>'
})
};

fetch('https://api.bitbybit.studio/bitlogin/api/open/v1/loyalty/reward-options', 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.bitbybit.studio/bitlogin/api/open/v1/loyalty/reward-options",
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([
'rewardName' => '<string>',
'costToRedeem' => 2,
'discountValue' => '<string>',
'voucherPrefix' => '<string>',
'minimumPurchaseAmount' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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.bitbybit.studio/bitlogin/api/open/v1/loyalty/reward-options"

payload := strings.NewReader("{\n \"rewardName\": \"<string>\",\n \"costToRedeem\": 2,\n \"discountValue\": \"<string>\",\n \"voucherPrefix\": \"<string>\",\n \"minimumPurchaseAmount\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<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.post("https://api.bitbybit.studio/bitlogin/api/open/v1/loyalty/reward-options")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rewardName\": \"<string>\",\n \"costToRedeem\": 2,\n \"discountValue\": \"<string>\",\n \"voucherPrefix\": \"<string>\",\n \"minimumPurchaseAmount\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bitbybit.studio/bitlogin/api/open/v1/loyalty/reward-options")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rewardName\": \"<string>\",\n \"costToRedeem\": 2,\n \"discountValue\": \"<string>\",\n \"voucherPrefix\": \"<string>\",\n \"minimumPurchaseAmount\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "companyId": 123,
  "rewardName": "<string>",
  "costToRedeem": 123,
  "discountValue": 123,
  "voucherPrefix": "<string>",
  "minimumPurchaseAmount": 123,
  "priceRuleId": "<string>",
  "startsAt": "2023-11-07T05:31:56Z",
  "endsAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Body

application/json
rewardName
string
required
costToRedeem
integer
required
Required range: x >= 1
discountType
enum<string>
required
Available options:
fixed_amount,
percentage,
free_shipping
discountValue
required

Decimal string up to 4 decimals. Percentage must be 1-100.

expirationPreset
enum<string>
required
Available options:
NO_EXPIRATION,
SEVEN_DAYS,
THIRTY_DAYS,
NINETY_DAYS,
ONE_YEAR
voucherPrefix
string | null
minimumPurchaseAmount

Decimal string up to 4 decimals.

Response

201 - application/json

Created

id
string
companyId
integer
rewardName
string
costToRedeem
integer
discountType
enum<string>
Available options:
fixed_amount,
percentage,
free_shipping
discountValue
number
voucherPrefix
string | null
minimumPurchaseAmount
number
expirationPreset
enum<string>
Available options:
NO_EXPIRATION,
SEVEN_DAYS,
THIRTY_DAYS,
NINETY_DAYS,
ONE_YEAR
priceRuleId
string
startsAt
string<date-time>
endsAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>