Customer orders

GET

api

orders

{shopId}

customers

{nickname}

orders

Customer orders

curl --request GET \
  --url https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/orders \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/orders"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/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/{shopId}/customers/{nickname}/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/orders")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "success": true,
  "data": [
    {
      "_id": "664f1a2b3c4d5e6f7a8b9c0d",
      "orderNumber": "3a7b9c2d",
      "status": "paid",
      "product": {
        "id": "664f1a2b3c4d5e6f7a8b9c0d",
        "name": "<string>",
        "price": 123
      },
      "customer": {
        "nickname": "Steve",
        "email": "<string>"
      },
      "payment": {
        "amount": 19.99,
        "currency": "PLN",
        "fee": {
          "percentage": 123,
          "amount": 123,
          "netAmount": 123
        }
      },
      "vat": {
        "enabled": true,
        "rate": 23,
        "amount": 123,
        "netAmount": 123
      },
      "quantity": 1,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "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/..."
}

{
  "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/..."
}

Authorizations

X-API-Key

string

header

required

Path Parameters

shopId

string

required

Shop ID (ObjectId)

nickname

string

required

Player nickname

Query Parameters

limit

string

Response

success

boolean

Example:

true

data

object[]

Show child attributes

message

string

Orders by status

Customer orders

curl --request GET \
  --url https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/orders \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/orders"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/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/{shopId}/customers/{nickname}/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/orders/{shopId}/customers/{nickname}/orders")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "success": true,
  "data": [
    {
      "_id": "664f1a2b3c4d5e6f7a8b9c0d",
      "orderNumber": "3a7b9c2d",
      "status": "paid",
      "product": {
        "id": "664f1a2b3c4d5e6f7a8b9c0d",
        "name": "<string>",
        "price": 123
      },
      "customer": {
        "nickname": "Steve",
        "email": "<string>"
      },
      "payment": {
        "amount": 19.99,
        "currency": "PLN",
        "fee": {
          "percentage": 123,
          "amount": 123,
          "netAmount": 123
        }
      },
      "vat": {
        "enabled": true,
        "rate": 23,
        "amount": 123,
        "netAmount": 123
      },
      "quantity": 1,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "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/..."
}

{
  "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

Authorizations

Path Parameters

Query Parameters

Response