Create an order

POST

api

orders

Create an order

curl --request POST \
  --url https://api.itemshop.dev/api/v2/orders \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'cf-turnstile-response: <cf-turnstile-response>' \
  --data '
{
  "productId": "664f1a2b3c4d5e6f7a8b9c0d",
  "nickname": "Steve",
  "termsAccepted": true,
  "immediatePerformanceConsent": true,
  "withdrawalAcknowledged": true,
  "legalDocumentVersion": "<string>",
  "paymentMethodName": "imojeTransfer:blik",
  "email": "klient@example.com",
  "quantity": 1,
  "discountCode": "LATO10",
  "metadata": {
    "variant": "<string>"
  }
}
'

import requests

url = "https://api.itemshop.dev/api/v2/orders"

payload = {
    "productId": "664f1a2b3c4d5e6f7a8b9c0d",
    "nickname": "Steve",
    "termsAccepted": True,
    "immediatePerformanceConsent": True,
    "withdrawalAcknowledged": True,
    "legalDocumentVersion": "<string>",
    "paymentMethodName": "imojeTransfer:blik",
    "email": "klient@example.com",
    "quantity": 1,
    "discountCode": "LATO10",
    "metadata": { "variant": "<string>" }
}
headers = {
    "cf-turnstile-response": "<cf-turnstile-response>",
    "Idempotency-Key": "<idempotency-key>",
    "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>',
    'Idempotency-Key': '<idempotency-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    productId: '664f1a2b3c4d5e6f7a8b9c0d',
    nickname: 'Steve',
    termsAccepted: true,
    immediatePerformanceConsent: true,
    withdrawalAcknowledged: true,
    legalDocumentVersion: '<string>',
    paymentMethodName: 'imojeTransfer:blik',
    email: 'klient@example.com',
    quantity: 1,
    discountCode: 'LATO10',
    metadata: {variant: '<string>'}
  })
};

fetch('https://api.itemshop.dev/api/v2/orders', 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/orders",
  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([
    'productId' => '664f1a2b3c4d5e6f7a8b9c0d',
    'nickname' => 'Steve',
    'termsAccepted' => true,
    'immediatePerformanceConsent' => true,
    'withdrawalAcknowledged' => true,
    'legalDocumentVersion' => '<string>',
    'paymentMethodName' => 'imojeTransfer:blik',
    'email' => 'klient@example.com',
    'quantity' => 1,
    'discountCode' => 'LATO10',
    'metadata' => [
        'variant' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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/orders"

	payload := strings.NewReader("{\n  \"productId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\",\n  \"termsAccepted\": true,\n  \"immediatePerformanceConsent\": true,\n  \"withdrawalAcknowledged\": true,\n  \"legalDocumentVersion\": \"<string>\",\n  \"paymentMethodName\": \"imojeTransfer:blik\",\n  \"email\": \"klient@example.com\",\n  \"quantity\": 1,\n  \"discountCode\": \"LATO10\",\n  \"metadata\": {\n    \"variant\": \"<string>\"\n  }\n}")

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

	req.Header.Add("cf-turnstile-response", "<cf-turnstile-response>")
	req.Header.Add("Idempotency-Key", "<idempotency-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.itemshop.dev/api/v2/orders")
  .header("cf-turnstile-response", "<cf-turnstile-response>")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\",\n  \"termsAccepted\": true,\n  \"immediatePerformanceConsent\": true,\n  \"withdrawalAcknowledged\": true,\n  \"legalDocumentVersion\": \"<string>\",\n  \"paymentMethodName\": \"imojeTransfer:blik\",\n  \"email\": \"klient@example.com\",\n  \"quantity\": 1,\n  \"discountCode\": \"LATO10\",\n  \"metadata\": {\n    \"variant\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"productId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\",\n  \"termsAccepted\": true,\n  \"immediatePerformanceConsent\": true,\n  \"withdrawalAcknowledged\": true,\n  \"legalDocumentVersion\": \"<string>\",\n  \"paymentMethodName\": \"imojeTransfer:blik\",\n  \"email\": \"klient@example.com\",\n  \"quantity\": 1,\n  \"discountCode\": \"LATO10\",\n  \"metadata\": {\n    \"variant\": \"<string>\"\n  }\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 checkout widget (required in production)

Idempotency-Key

string

required

Random UUID/base64url attempt key (32-128 characters); reuse only for an identical retry

Body

application/json

productId

string

required

Product ID (ObjectId)

Pattern: ^[0-9a-fA-F]{24}$

Example:

"664f1a2b3c4d5e6f7a8b9c0d"

nickname

string

required

Player nickname (3–16 chars)

Example:

"Steve"

termsAccepted

boolean

required

Seller terms accepted

Immediate digital performance requested

withdrawalAcknowledged

boolean

required

Withdrawal-right acknowledgement

legalDocumentVersion

string

required

SHA-256 of the legal documents shown to the buyer

Pattern: ^[a-f0-9]{64}$

paymentMethodName

string

Payment method name; required only for paid orders

Required string length: 1 - 100

Example:

"imojeTransfer:blik"

string<email>

Buyer email (for confirmation)

Required string length: 3 - 254

Example:

"klient@example.com"

quantity

number

Quantity

Required range: 1 <= x <= 100000

Example:

1

discountCode

string

Discount code

Required string length: 1 - 50

Pattern: ^[A-Za-z0-9_-]+$

Example:

"LATO10"

metadata

object

Whitelisted checkout metadata

Show child attributes

Response

success

boolean

Example:

true

data

object

message

string

Shop orders

Create an order

curl --request POST \
  --url https://api.itemshop.dev/api/v2/orders \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'cf-turnstile-response: <cf-turnstile-response>' \
  --data '
{
  "productId": "664f1a2b3c4d5e6f7a8b9c0d",
  "nickname": "Steve",
  "termsAccepted": true,
  "immediatePerformanceConsent": true,
  "withdrawalAcknowledged": true,
  "legalDocumentVersion": "<string>",
  "paymentMethodName": "imojeTransfer:blik",
  "email": "klient@example.com",
  "quantity": 1,
  "discountCode": "LATO10",
  "metadata": {
    "variant": "<string>"
  }
}
'

import requests

url = "https://api.itemshop.dev/api/v2/orders"

payload = {
    "productId": "664f1a2b3c4d5e6f7a8b9c0d",
    "nickname": "Steve",
    "termsAccepted": True,
    "immediatePerformanceConsent": True,
    "withdrawalAcknowledged": True,
    "legalDocumentVersion": "<string>",
    "paymentMethodName": "imojeTransfer:blik",
    "email": "klient@example.com",
    "quantity": 1,
    "discountCode": "LATO10",
    "metadata": { "variant": "<string>" }
}
headers = {
    "cf-turnstile-response": "<cf-turnstile-response>",
    "Idempotency-Key": "<idempotency-key>",
    "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>',
    'Idempotency-Key': '<idempotency-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    productId: '664f1a2b3c4d5e6f7a8b9c0d',
    nickname: 'Steve',
    termsAccepted: true,
    immediatePerformanceConsent: true,
    withdrawalAcknowledged: true,
    legalDocumentVersion: '<string>',
    paymentMethodName: 'imojeTransfer:blik',
    email: 'klient@example.com',
    quantity: 1,
    discountCode: 'LATO10',
    metadata: {variant: '<string>'}
  })
};

fetch('https://api.itemshop.dev/api/v2/orders', 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/orders",
  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([
    'productId' => '664f1a2b3c4d5e6f7a8b9c0d',
    'nickname' => 'Steve',
    'termsAccepted' => true,
    'immediatePerformanceConsent' => true,
    'withdrawalAcknowledged' => true,
    'legalDocumentVersion' => '<string>',
    'paymentMethodName' => 'imojeTransfer:blik',
    'email' => 'klient@example.com',
    'quantity' => 1,
    'discountCode' => 'LATO10',
    'metadata' => [
        'variant' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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/orders"

	payload := strings.NewReader("{\n  \"productId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\",\n  \"termsAccepted\": true,\n  \"immediatePerformanceConsent\": true,\n  \"withdrawalAcknowledged\": true,\n  \"legalDocumentVersion\": \"<string>\",\n  \"paymentMethodName\": \"imojeTransfer:blik\",\n  \"email\": \"klient@example.com\",\n  \"quantity\": 1,\n  \"discountCode\": \"LATO10\",\n  \"metadata\": {\n    \"variant\": \"<string>\"\n  }\n}")

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

	req.Header.Add("cf-turnstile-response", "<cf-turnstile-response>")
	req.Header.Add("Idempotency-Key", "<idempotency-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.itemshop.dev/api/v2/orders")
  .header("cf-turnstile-response", "<cf-turnstile-response>")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\",\n  \"termsAccepted\": true,\n  \"immediatePerformanceConsent\": true,\n  \"withdrawalAcknowledged\": true,\n  \"legalDocumentVersion\": \"<string>\",\n  \"paymentMethodName\": \"imojeTransfer:blik\",\n  \"email\": \"klient@example.com\",\n  \"quantity\": 1,\n  \"discountCode\": \"LATO10\",\n  \"metadata\": {\n    \"variant\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"productId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"nickname\": \"Steve\",\n  \"termsAccepted\": true,\n  \"immediatePerformanceConsent\": true,\n  \"withdrawalAcknowledged\": true,\n  \"legalDocumentVersion\": \"<string>\",\n  \"paymentMethodName\": \"imojeTransfer:blik\",\n  \"email\": \"klient@example.com\",\n  \"quantity\": 1,\n  \"discountCode\": \"LATO10\",\n  \"metadata\": {\n    \"variant\": \"<string>\"\n  }\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