List all orders
curl --request GET \
--url http://localhost:3000/v2/orders/ \
--header 'x-API-Key: <api-key>'import requests
url = "http://localhost:3000/v2/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('http://localhost:3000/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/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 := "http://localhost:3000/v2/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))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/orders/")
.header("x-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/orders/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"items": [
{}
],
"customOrder": true,
"comment": "<string>",
"userId": "<string>",
"objectId": "<string>",
"completed": true,
"approvedBy": "<string>",
"objectManagerId": "<string>",
"invoiceId": "<string>"
}
]Material Orders
List Material Orders
Get a list of all material orders. Supports filtering, pagination, and sorting.
GET
/
orders
/
List all orders
curl --request GET \
--url http://localhost:3000/v2/orders/ \
--header 'x-API-Key: <api-key>'import requests
url = "http://localhost:3000/v2/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('http://localhost:3000/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/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 := "http://localhost:3000/v2/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))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/orders/")
.header("x-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/orders/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"items": [
{}
],
"customOrder": true,
"comment": "<string>",
"userId": "<string>",
"objectId": "<string>",
"completed": true,
"approvedBy": "<string>",
"objectManagerId": "<string>",
"invoiceId": "<string>"
}
]Authorizations
API-KeyBearer-Auth
Query Parameters
Required range:
1 <= x <= 1000Required range:
x >= 0Response
List of orders
Unique identifier of the entity
Unique number of the entity, used for identification
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
ID of the chat associated with this entity
List of order items
Whether this is a custom order
Order comment
User who created the order
Object (location) for which the order is made
Whether the order is completed
User who approved the order
Object manager responsible for the order
Invoice linked to this order
Was this page helpful?

