Public order status

GET

api

orders

public

{orderId}

status

Public order status

curl --request GET \
  --url https://api.itemshop.dev/api/v2/orders/public/{orderId}/status \
  --header 'x-order-status-token: <x-order-status-token>'

import requests

url = "https://api.itemshop.dev/api/v2/orders/public/{orderId}/status"

headers = {"x-order-status-token": "<x-order-status-token>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-order-status-token': '<x-order-status-token>'}};

fetch('https://api.itemshop.dev/api/v2/orders/public/{orderId}/status', 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/public/{orderId}/status",
  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-order-status-token: <x-order-status-token>"
  ],
]);

$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/public/{orderId}/status"

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

	req.Header.Add("x-order-status-token", "<x-order-status-token>")

	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/public/{orderId}/status")

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

request = Net::HTTP::Get.new(url)
request["x-order-status-token"] = '<x-order-status-token>'

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

x-order-status-token

string

required

Opaque capability returned by checkout; required to read this order status

Path Parameters

orderId

string

required

Order ID (ObjectId)

Response

success

boolean

Example:

true

data

object

message

string

Public order status

curl --request GET \
  --url https://api.itemshop.dev/api/v2/orders/public/{orderId}/status \
  --header 'x-order-status-token: <x-order-status-token>'

import requests

url = "https://api.itemshop.dev/api/v2/orders/public/{orderId}/status"

headers = {"x-order-status-token": "<x-order-status-token>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-order-status-token': '<x-order-status-token>'}};

fetch('https://api.itemshop.dev/api/v2/orders/public/{orderId}/status', 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/public/{orderId}/status",
  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-order-status-token: <x-order-status-token>"
  ],
]);

$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/public/{orderId}/status"

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

	req.Header.Add("x-order-status-token", "<x-order-status-token>")

	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/public/{orderId}/status")

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

request = Net::HTTP::Get.new(url)
request["x-order-status-token"] = '<x-order-status-token>'

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

Path Parameters

Response