Redeem a voucher

POST

api

vouchers

redeem

Redeem a voucher

curl --request POST \
  --url https://api.itemshop.dev/api/v2/vouchers/redeem \
  --header 'Content-Type: application/json' \
  --header 'cf-turnstile-response: <cf-turnstile-response>' \
  --data '
{
  "code": "ABC123",
  "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
  "nickname": "Steve"
}
'

import requests

url = "https://api.itemshop.dev/api/v2/vouchers/redeem"

payload = {
    "code": "ABC123",
    "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
    "nickname": "Steve"
}
headers = {
    "cf-turnstile-response": "<cf-turnstile-response>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'cf-turnstile-response': '<cf-turnstile-response>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({code: 'ABC123', shopId: '664f1a2b3c4d5e6f7a8b9c0d', nickname: 'Steve'})
};

fetch('https://api.itemshop.dev/api/v2/vouchers/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.itemshop.dev/api/v2/vouchers/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([
    'code' => 'ABC123',
    'shopId' => '664f1a2b3c4d5e6f7a8b9c0d',
    'nickname' => 'Steve'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "cf-turnstile-response: <cf-turnstile-response>"
  ],
]);

$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.itemshop.dev/api/v2/vouchers/redeem"

	payload := strings.NewReader("{\n  \"code\": \"ABC123\",\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\"\n}")

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

	req.Header.Add("cf-turnstile-response", "<cf-turnstile-response>")
	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.itemshop.dev/api/v2/vouchers/redeem")
  .header("cf-turnstile-response", "<cf-turnstile-response>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"ABC123\",\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/vouchers/redeem")

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

request = Net::HTTP::Post.new(url)
request["cf-turnstile-response"] = '<cf-turnstile-response>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"ABC123\",\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {},
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

Headers

cf-turnstile-response

string

required

Cloudflare Turnstile token from the storefront widget (required in production)

Body

application/json

code

string

required

Voucher code

Example:

"ABC123"

shopId

string

required

Shop ID (ObjectId)

Example:

"664f1a2b3c4d5e6f7a8b9c0d"

nickname

string

required

Player nickname

Example:

"Steve"

Response

success

boolean

Example:

true

data

object

message

string

Public voucher check

Redeem a voucher

curl --request POST \
  --url https://api.itemshop.dev/api/v2/vouchers/redeem \
  --header 'Content-Type: application/json' \
  --header 'cf-turnstile-response: <cf-turnstile-response>' \
  --data '
{
  "code": "ABC123",
  "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
  "nickname": "Steve"
}
'

import requests

url = "https://api.itemshop.dev/api/v2/vouchers/redeem"

payload = {
    "code": "ABC123",
    "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
    "nickname": "Steve"
}
headers = {
    "cf-turnstile-response": "<cf-turnstile-response>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'cf-turnstile-response': '<cf-turnstile-response>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({code: 'ABC123', shopId: '664f1a2b3c4d5e6f7a8b9c0d', nickname: 'Steve'})
};

fetch('https://api.itemshop.dev/api/v2/vouchers/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.itemshop.dev/api/v2/vouchers/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([
    'code' => 'ABC123',
    'shopId' => '664f1a2b3c4d5e6f7a8b9c0d',
    'nickname' => 'Steve'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "cf-turnstile-response: <cf-turnstile-response>"
  ],
]);

$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.itemshop.dev/api/v2/vouchers/redeem"

	payload := strings.NewReader("{\n  \"code\": \"ABC123\",\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\"\n}")

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

	req.Header.Add("cf-turnstile-response", "<cf-turnstile-response>")
	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.itemshop.dev/api/v2/vouchers/redeem")
  .header("cf-turnstile-response", "<cf-turnstile-response>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"ABC123\",\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/vouchers/redeem")

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

request = Net::HTTP::Post.new(url)
request["cf-turnstile-response"] = '<cf-turnstile-response>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"ABC123\",\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {},
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

Getting started

Basics

Payments

Order fulfillment

Configuration

API Keys

Shops

Servers

Products

Payment Methods

Blacklist

Discounts

Vouchers

Stats

Storage

Orders

Payments

Components

Metrics

Headers

Body

Response