Skip to main content
GET
/
api
/
org
/
v1
/
orders
List Orders
curl --request GET \
  --url https://console.lomaplatform.com/api/org/v1/orders \
  --header 'API-Key: <api-key>'
import requests

url = "https://console.lomaplatform.com/api/org/v1/orders"

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

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

print(response.text)
const options = {method: 'GET', headers: {'API-Key': '<api-key>'}};

fetch('https://console.lomaplatform.com/api/org/v1/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://console.lomaplatform.com/api/org/v1/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 => [
"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://console.lomaplatform.com/api/org/v1/orders"

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

req.Header.Add("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("https://console.lomaplatform.com/api/org/v1/orders")
.header("API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://console.lomaplatform.com/api/org/v1/orders")

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

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

response = http.request(request)
puts response.read_body
[
  {
    "id": "<string>",
    "status": "<string>",
    "payment_date": "<string>",
    "subtotal": "<string>",
    "total": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "requirements_due": "<string>",
    "requirements_submitted": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "items": [
      {
        "id": "<string>",
        "price": 123,
        "status": "<string>",
        "product": {
          "id": "<string>",
          "name": "<string>"
        },
        "package": {
          "id": "<string>",
          "name": "<string>"
        },
        "vendor": {
          "id": "<string>",
          "name": "<string>"
        },
        "category": {
          "id": "<string>",
          "name": "<string>"
        },
        "locations": [
          {
            "id": "<string>",
            "name": "<string>",
            "primary": true,
            "external_id": "<string>",
            "address_line_1": "<string>",
            "address_city": "<string>",
            "address_state": "<string>",
            "address_zip": "<string>"
          }
        ],
        "kpis": [
          {
            "id": "<string>",
            "name": "<string>",
            "benchmark": 123,
            "value": 123
          }
        ]
      }
    ]
  }
]
{
"error": {
"issues": [
"<unknown>"
],
"name": "<string>"
}
}
{
"error": {
"status": 401,
"message": "Invalid API Key"
}
}

Authorizations

API-Key
string
header
required

API Key for the organization

Query Parameters

page
number
default:1
Required range: x >= 1
limit
number
default:25
Required range: 1 <= x <= 1000
sort
enum<string>
default:created_at
Available options:
created_at,
updated_at
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

200 OK

id
string
required
status
string
required
payment_date
string | null
required
subtotal
string
required
total
string
required
start_date
string
required
end_date
string
required
requirements_due
string | null
required
requirements_submitted
string | null
required
created_at
string
required
updated_at
string
required
items
object[]
required