Create Order

Create order

curl --request POST \
  --url https://api.komerza.com/stores/{storeId}/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 50000
    }
  ],
  "gateway": "<string>",
  "emailAddress": "jsmith@example.com",
  "sendReceipt": true,
  "buyerProtection": true,
  "cost": 500000.005,
  "couponCode": "<string>",
  "affiliateCode": "<string>",
  "returnUrl": "<string>",
  "metadata": {},
  "ipAddress": "<string>",
  "userAgent": "<string>",
  "countryCode": "<string>",
  "currency": "<string>"
}
'

import requests

url = "https://api.komerza.com/stores/{storeId}/orders"

payload = {
    "items": [
        {
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 50000
        }
    ],
    "gateway": "<string>",
    "emailAddress": "jsmith@example.com",
    "sendReceipt": True,
    "buyerProtection": True,
    "cost": 500000.005,
    "couponCode": "<string>",
    "affiliateCode": "<string>",
    "returnUrl": "<string>",
    "metadata": {},
    "ipAddress": "<string>",
    "userAgent": "<string>",
    "countryCode": "<string>",
    "currency": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        variantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 50000
      }
    ],
    gateway: '<string>',
    emailAddress: 'jsmith@example.com',
    sendReceipt: true,
    buyerProtection: true,
    cost: 500000.005,
    couponCode: '<string>',
    affiliateCode: '<string>',
    returnUrl: '<string>',
    metadata: {},
    ipAddress: '<string>',
    userAgent: '<string>',
    countryCode: '<string>',
    currency: '<string>'
  })
};

fetch('https://api.komerza.com/stores/{storeId}/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.komerza.com/stores/{storeId}/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([
    'items' => [
        [
                'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'variantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity' => 50000
        ]
    ],
    'gateway' => '<string>',
    'emailAddress' => 'jsmith@example.com',
    'sendReceipt' => true,
    'buyerProtection' => true,
    'cost' => 500000.005,
    'couponCode' => '<string>',
    'affiliateCode' => '<string>',
    'returnUrl' => '<string>',
    'metadata' => [
        
    ],
    'ipAddress' => '<string>',
    'userAgent' => '<string>',
    'countryCode' => '<string>',
    'currency' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.komerza.com/stores/{storeId}/orders"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50000\n    }\n  ],\n  \"gateway\": \"<string>\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"sendReceipt\": true,\n  \"buyerProtection\": true,\n  \"cost\": 500000.005,\n  \"couponCode\": \"<string>\",\n  \"affiliateCode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"metadata\": {},\n  \"ipAddress\": \"<string>\",\n  \"userAgent\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"currency\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.komerza.com/stores/{storeId}/orders")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50000\n    }\n  ],\n  \"gateway\": \"<string>\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"sendReceipt\": true,\n  \"buyerProtection\": true,\n  \"cost\": 500000.005,\n  \"couponCode\": \"<string>\",\n  \"affiliateCode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"metadata\": {},\n  \"ipAddress\": \"<string>\",\n  \"userAgent\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"currency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.komerza.com/stores/{storeId}/orders")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50000\n    }\n  ],\n  \"gateway\": \"<string>\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"sendReceipt\": true,\n  \"buyerProtection\": true,\n  \"cost\": 500000.005,\n  \"couponCode\": \"<string>\",\n  \"affiliateCode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"metadata\": {},\n  \"ipAddress\": \"<string>\",\n  \"userAgent\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"currency\": \"<string>\"\n}"

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

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "productName": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantName": "<string>",
        "amount": 123,
        "lineTotal": 123,
        "additionalFeePercentage": 123,
        "additionalFeeAmount": 123,
        "additionalFixedFeeAmount": 123,
        "volumeDiscountAmount": 123,
        "quantity": 123,
        "volumeDiscountValue": 123,
        "volumeDiscountTierQuantity": 123,
        "customIntervalDays": 123
      }
    ],
    "currencyCode": "<string>",
    "gateway": "<string>",
    "customer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "countryCode": "<string>",
      "emailAddress": "<string>",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "gatewayMetadata": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "transactionId": "<string>",
      "clientSecret": "<string>",
      "note": "<string>",
      "cryptocurrencyAddress": "<string>",
      "cryptocurrencyAmount": 123,
      "cryptocurrencyExpiration": "2023-11-07T05:31:56Z",
      "cryptocurrencyPaymentUri": "<string>",
      "chargeCurrencyCode": "<string>",
      "chargeFxRate": 123
    },
    "status": "<string>",
    "amountPaid": 123,
    "amount": 123,
    "isBuyerProtected": true,
    "protectionFeeNative": 123,
    "protectionFeeEur": 123,
    "isTopUp": true,
    "appliedBalance": 123,
    "amountDueToGateway": 123,
    "globalGatewayFeePercentage": 123,
    "globalGatewayFeeAmount": 123,
    "globalGatewayFixedFee": 123,
    "globalGatewayFixedFeeAmount": 123,
    "deliveredItems": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "source": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "textContent": "<string>",
        "file": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "friendlyName": "<string>"
        }
      }
    ],
    "deliveryInstructions": [
      {
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "productName": "<string>",
        "variantName": "<string>",
        "message": "<string>"
      }
    ],
    "source": "<string>",
    "presentmentCurrencyCode": "<string>",
    "presentmentFxRate": 123,
    "chargeback": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "reason": "<string>"
    },
    "balanceTopUpAmount": 123,
    "coupon": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "netDecrease": 123,
      "code": "<string>",
      "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "percentageDecrease": 123
    },
    "affiliateDiscount": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "netDecrease": 123,
      "percentageDecrease": 123
    },
    "tax": {
      "taxAmount": 123,
      "taxRate": 123,
      "taxName": "<string>",
      "isReverseCharge": true,
      "preTaxAmount": 123,
      "taxBehavior": "<string>",
      "customerVatId": "<string>"
    },
    "customFieldAnswers": {},
    "returnUrl": "<string>",
    "metadata": {},
    "discordAccount": {
      "discordUserId": "<string>",
      "username": "<string>",
      "displayName": "<string>",
      "avatarUrl": "<string>"
    },
    "marketingOptIn": true
  }
}

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

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

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

POST

stores

{storeId}

orders

Create order

curl --request POST \
  --url https://api.komerza.com/stores/{storeId}/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 50000
    }
  ],
  "gateway": "<string>",
  "emailAddress": "jsmith@example.com",
  "sendReceipt": true,
  "buyerProtection": true,
  "cost": 500000.005,
  "couponCode": "<string>",
  "affiliateCode": "<string>",
  "returnUrl": "<string>",
  "metadata": {},
  "ipAddress": "<string>",
  "userAgent": "<string>",
  "countryCode": "<string>",
  "currency": "<string>"
}
'

import requests

url = "https://api.komerza.com/stores/{storeId}/orders"

payload = {
    "items": [
        {
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 50000
        }
    ],
    "gateway": "<string>",
    "emailAddress": "jsmith@example.com",
    "sendReceipt": True,
    "buyerProtection": True,
    "cost": 500000.005,
    "couponCode": "<string>",
    "affiliateCode": "<string>",
    "returnUrl": "<string>",
    "metadata": {},
    "ipAddress": "<string>",
    "userAgent": "<string>",
    "countryCode": "<string>",
    "currency": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        variantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 50000
      }
    ],
    gateway: '<string>',
    emailAddress: 'jsmith@example.com',
    sendReceipt: true,
    buyerProtection: true,
    cost: 500000.005,
    couponCode: '<string>',
    affiliateCode: '<string>',
    returnUrl: '<string>',
    metadata: {},
    ipAddress: '<string>',
    userAgent: '<string>',
    countryCode: '<string>',
    currency: '<string>'
  })
};

fetch('https://api.komerza.com/stores/{storeId}/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.komerza.com/stores/{storeId}/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([
    'items' => [
        [
                'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'variantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity' => 50000
        ]
    ],
    'gateway' => '<string>',
    'emailAddress' => 'jsmith@example.com',
    'sendReceipt' => true,
    'buyerProtection' => true,
    'cost' => 500000.005,
    'couponCode' => '<string>',
    'affiliateCode' => '<string>',
    'returnUrl' => '<string>',
    'metadata' => [
        
    ],
    'ipAddress' => '<string>',
    'userAgent' => '<string>',
    'countryCode' => '<string>',
    'currency' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.komerza.com/stores/{storeId}/orders"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50000\n    }\n  ],\n  \"gateway\": \"<string>\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"sendReceipt\": true,\n  \"buyerProtection\": true,\n  \"cost\": 500000.005,\n  \"couponCode\": \"<string>\",\n  \"affiliateCode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"metadata\": {},\n  \"ipAddress\": \"<string>\",\n  \"userAgent\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"currency\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.komerza.com/stores/{storeId}/orders")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50000\n    }\n  ],\n  \"gateway\": \"<string>\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"sendReceipt\": true,\n  \"buyerProtection\": true,\n  \"cost\": 500000.005,\n  \"couponCode\": \"<string>\",\n  \"affiliateCode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"metadata\": {},\n  \"ipAddress\": \"<string>\",\n  \"userAgent\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"currency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.komerza.com/stores/{storeId}/orders")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50000\n    }\n  ],\n  \"gateway\": \"<string>\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"sendReceipt\": true,\n  \"buyerProtection\": true,\n  \"cost\": 500000.005,\n  \"couponCode\": \"<string>\",\n  \"affiliateCode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"metadata\": {},\n  \"ipAddress\": \"<string>\",\n  \"userAgent\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"currency\": \"<string>\"\n}"

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

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "productName": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantName": "<string>",
        "amount": 123,
        "lineTotal": 123,
        "additionalFeePercentage": 123,
        "additionalFeeAmount": 123,
        "additionalFixedFeeAmount": 123,
        "volumeDiscountAmount": 123,
        "quantity": 123,
        "volumeDiscountValue": 123,
        "volumeDiscountTierQuantity": 123,
        "customIntervalDays": 123
      }
    ],
    "currencyCode": "<string>",
    "gateway": "<string>",
    "customer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "countryCode": "<string>",
      "emailAddress": "<string>",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "gatewayMetadata": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "transactionId": "<string>",
      "clientSecret": "<string>",
      "note": "<string>",
      "cryptocurrencyAddress": "<string>",
      "cryptocurrencyAmount": 123,
      "cryptocurrencyExpiration": "2023-11-07T05:31:56Z",
      "cryptocurrencyPaymentUri": "<string>",
      "chargeCurrencyCode": "<string>",
      "chargeFxRate": 123
    },
    "status": "<string>",
    "amountPaid": 123,
    "amount": 123,
    "isBuyerProtected": true,
    "protectionFeeNative": 123,
    "protectionFeeEur": 123,
    "isTopUp": true,
    "appliedBalance": 123,
    "amountDueToGateway": 123,
    "globalGatewayFeePercentage": 123,
    "globalGatewayFeeAmount": 123,
    "globalGatewayFixedFee": 123,
    "globalGatewayFixedFeeAmount": 123,
    "deliveredItems": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "source": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "textContent": "<string>",
        "file": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "friendlyName": "<string>"
        }
      }
    ],
    "deliveryInstructions": [
      {
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "productName": "<string>",
        "variantName": "<string>",
        "message": "<string>"
      }
    ],
    "source": "<string>",
    "presentmentCurrencyCode": "<string>",
    "presentmentFxRate": 123,
    "chargeback": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "reason": "<string>"
    },
    "balanceTopUpAmount": 123,
    "coupon": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "netDecrease": 123,
      "code": "<string>",
      "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "percentageDecrease": 123
    },
    "affiliateDiscount": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "netDecrease": 123,
      "percentageDecrease": 123
    },
    "tax": {
      "taxAmount": 123,
      "taxRate": 123,
      "taxName": "<string>",
      "isReverseCharge": true,
      "preTaxAmount": 123,
      "taxBehavior": "<string>",
      "customerVatId": "<string>"
    },
    "customFieldAnswers": {},
    "returnUrl": "<string>",
    "metadata": {},
    "discordAccount": {
      "discordUserId": "<string>",
      "username": "<string>",
      "displayName": "<string>",
      "avatarUrl": "<string>"
    },
    "marketingOptIn": true
  }
}

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

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

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

Payment Methods

When creating an order, specify the paymentMethod field using one of the supported payment method codes. See the Payment Methods reference for the complete list of available options.

Redirecting to Checkout

After successfully creating an order, redirect the customer to the hosted checkout page to complete payment:

https://checkout.komerza.com/checkout/{orderId}

Example

const response = await fetch(`/stores/${storeId}/orders`, {
  method: "POST",
  headers: { Authorization: `Bearer ${apiKey}` },
  body: JSON.stringify(orderData),
});

const result = await response.json();

if (result.success) {
  const orderId = result.data.id;
  window.location.href = `https://checkout.komerza.com/checkout/${orderId}`;
}

The checkout page handles payment processing, order confirmation, and receipt generation automatically.

Authorizations

Authorization

string

header

required

Your API key goes here

Path Parameters

storeId

string<uuid>

required

The ID of the store the order will be created in.

Body

application/json

The form containing the order details.

Form to create an order on the dashboard. Supply either Komerza.Common.Forms.Orders.CreateDashboardOrderForm.Cost for a product-less invoice, or Komerza.Common.Forms.Orders.LineItemsForm.Items for a standard product order.

items

object[]

required

Hides the base Komerza.Common.Forms.Orders.LineItemsForm.Items to remove the [Required] / [Length] constraints, since items are optional when Komerza.Common.Forms.Orders.CreateDashboardOrderForm.Cost is provided.

Show child attributes

gateway

string

required

The specific payment method ID to use for this order

Required string length: 1 - 256

emailAddress

string<email>

required

The email address of the customer placing the order

Maximum string length: 256

sendReceipt

boolean

required

Whether to send a receipt email to the customer after the order is completed. Defaults to true.

buyerProtection

boolean

required

Whether the customer opted into Komerza Buyer Protection for this order. Ignored unless the store is approved and has buyer protection enabled; the protection fee is always computed server-side. If the store has made protection mandatory this value is overridden to on (the buyer cannot opt out).

cost

number<double> | null

An arbitrary total to charge the customer, without referencing any products. When set, Items is ignored and the order is created with no line items.

Required range: 0.01 <= x <= 1000000

couponCode

string | null

The coupon code that the customer is applying to the order

Maximum string length: 32

affiliateCode

string | null

The affiliate code (store affiliate link) to apply to this order.

Maximum string length: 256

returnUrl

string<uri> | null

The URL to redirect the customer to after payment completion. If not provided, the store's default return URL will be used.

Maximum string length: 2048

metadata

object | null

Custom key-value metadata to attach to the order for your own tracking purposes. Maximum of 20 keys, each key max 40 characters, each value max 500 characters.

Show child attributes

ipAddress

string | null

The IP address of the customer placing the order

Maximum string length: 45

userAgent

string | null

The browser user agent of the customer placing the order, you can get this from the request headers or using JavaScript

Maximum string length: 512

countryCode

string | null

The 2-digit country code (ISO 3166-1 alpha-2) of the customer placing the order

Maximum string length: 2

currency

string | null

Optional adaptive-currency presentment currency (ISO code, e.g. gbp) to price this order in at creation. When supplied - and the store has adaptive currency enabled and it differs from the store's base currency - the order is created (and its provider session minted) in this currency. Leave null for a payment link whose currency the shopper picks at checkout (see the checkout setCurrency endpoint); the order is then created in the store's base currency.

Maximum string length: 3

Response

The object was successfully created.

Represents a default generic response for API endpoints.

success

boolean

required

Indicates whether the operation or response was successful.

message

string | null

A descriptive message providing additional context or information about the response.

code

string | null

The error code (if there was an error) to use when referencing the error

data

object

An order made by a customer to a merchant for a product they are selling

Show child attributes

Last modified on December 14, 2025

Search Orders

Deliver Order

API Documentation

Reference

OAuth2

User

Stores

Products

Categories

Variants

Coupons

Tickets

Customers

Orders

Reviews

Affiliates

Webhooks

Payment Methods

Redirecting to Checkout

Example

Authorizations

Path Parameters

Body

Response

​Payment Methods

​Redirecting to Checkout

​Example

Authorizations

Path Parameters

Body

Response

Payment Methods

Redirecting to Checkout

Example