Rewards API
Record reward redemption
POST
/
v1
/
rewards
/
redeem
Record reward redemption
curl --request POST \
--url https://api.oneofnone.io/v1/rewards/redeem \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"rewardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discountAmount": 1,
"orderTotal": 1,
"codeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"grantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamAppUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "<string>",
"externalOrderId": "<string>",
"customerEmail": "jsmith@example.com",
"sessionId": "<string>",
"metadata": {}
}
'import requests
url = "https://api.oneofnone.io/v1/rewards/redeem"
payload = {
"rewardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discountAmount": 1,
"orderTotal": 1,
"codeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"grantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamAppUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "<string>",
"externalOrderId": "<string>",
"customerEmail": "jsmith@example.com",
"sessionId": "<string>",
"metadata": {}
}
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({
rewardId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
discountAmount: 1,
orderTotal: 1,
codeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
grantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
teamAppUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
orderId: '<string>',
externalOrderId: '<string>',
customerEmail: 'jsmith@example.com',
sessionId: '<string>',
metadata: {}
})
};
fetch('https://api.oneofnone.io/v1/rewards/redeem', 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.oneofnone.io/v1/rewards/redeem",
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([
'rewardId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'discountAmount' => 1,
'orderTotal' => 1,
'codeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'grantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'teamAppUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'orderId' => '<string>',
'externalOrderId' => '<string>',
'customerEmail' => 'jsmith@example.com',
'sessionId' => '<string>',
'metadata' => [
]
]),
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.oneofnone.io/v1/rewards/redeem"
payload := strings.NewReader("{\n \"rewardId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discountAmount\": 1,\n \"orderTotal\": 1,\n \"codeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"grantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamAppUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"orderId\": \"<string>\",\n \"externalOrderId\": \"<string>\",\n \"customerEmail\": \"jsmith@example.com\",\n \"sessionId\": \"<string>\",\n \"metadata\": {}\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.oneofnone.io/v1/rewards/redeem")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rewardId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discountAmount\": 1,\n \"orderTotal\": 1,\n \"codeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"grantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamAppUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"orderId\": \"<string>\",\n \"externalOrderId\": \"<string>\",\n \"customerEmail\": \"jsmith@example.com\",\n \"sessionId\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.oneofnone.io/v1/rewards/redeem")
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 \"rewardId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discountAmount\": 1,\n \"orderTotal\": 1,\n \"codeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"grantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamAppUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"orderId\": \"<string>\",\n \"externalOrderId\": \"<string>\",\n \"customerEmail\": \"jsmith@example.com\",\n \"sessionId\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"message": "<string>",
"code": "<string>",
"details": {}
}Authorizations
Body
application/json
Available options:
shopify, stripe, vault, manual Required range:
x >= 0Required range:
x >= 0Required string length:
1 - 500Required string length:
1 - 500Required string length:
1 - 200Show child attributes
Show child attributes
Response
Redemption recorded
Available options:
true ⌘I
Record reward redemption
curl --request POST \
--url https://api.oneofnone.io/v1/rewards/redeem \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"rewardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discountAmount": 1,
"orderTotal": 1,
"codeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"grantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamAppUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "<string>",
"externalOrderId": "<string>",
"customerEmail": "jsmith@example.com",
"sessionId": "<string>",
"metadata": {}
}
'import requests
url = "https://api.oneofnone.io/v1/rewards/redeem"
payload = {
"rewardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discountAmount": 1,
"orderTotal": 1,
"codeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"grantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamAppUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "<string>",
"externalOrderId": "<string>",
"customerEmail": "jsmith@example.com",
"sessionId": "<string>",
"metadata": {}
}
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({
rewardId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
discountAmount: 1,
orderTotal: 1,
codeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
grantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
teamAppUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
orderId: '<string>',
externalOrderId: '<string>',
customerEmail: 'jsmith@example.com',
sessionId: '<string>',
metadata: {}
})
};
fetch('https://api.oneofnone.io/v1/rewards/redeem', 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.oneofnone.io/v1/rewards/redeem",
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([
'rewardId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'discountAmount' => 1,
'orderTotal' => 1,
'codeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'grantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'teamAppUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'orderId' => '<string>',
'externalOrderId' => '<string>',
'customerEmail' => 'jsmith@example.com',
'sessionId' => '<string>',
'metadata' => [
]
]),
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.oneofnone.io/v1/rewards/redeem"
payload := strings.NewReader("{\n \"rewardId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discountAmount\": 1,\n \"orderTotal\": 1,\n \"codeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"grantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamAppUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"orderId\": \"<string>\",\n \"externalOrderId\": \"<string>\",\n \"customerEmail\": \"jsmith@example.com\",\n \"sessionId\": \"<string>\",\n \"metadata\": {}\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.oneofnone.io/v1/rewards/redeem")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rewardId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discountAmount\": 1,\n \"orderTotal\": 1,\n \"codeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"grantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamAppUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"orderId\": \"<string>\",\n \"externalOrderId\": \"<string>\",\n \"customerEmail\": \"jsmith@example.com\",\n \"sessionId\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.oneofnone.io/v1/rewards/redeem")
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 \"rewardId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discountAmount\": 1,\n \"orderTotal\": 1,\n \"codeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"grantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"teamAppUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"orderId\": \"<string>\",\n \"externalOrderId\": \"<string>\",\n \"customerEmail\": \"jsmith@example.com\",\n \"sessionId\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"message": "<string>",
"code": "<string>",
"details": {}
}