Skip to main content
GET
/
api
/
vendor
/
v1
/
orders
/
{id}
Get an order
curl --request GET \
  --url https://console.lomaplatform.com/api/vendor/v1/orders/{id} \
  --header 'API-Key: <api-key>'
import requests

url = "https://console.lomaplatform.com/api/vendor/v1/orders/{id}"

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/vendor/v1/orders/{id}', 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/vendor/v1/orders/{id}",
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/vendor/v1/orders/{id}"

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/vendor/v1/orders/{id}")
.header("API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://console.lomaplatform.com/api/vendor/v1/orders/{id}")

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": "i_abc123",
  "price": "575.00",
  "status": "completed",
  "created_at": "2024-08-23 19:10:23.266295+00",
  "updated_at": "2024-08-23 19:24:45.962+00",
  "requirements_due": "2024-09-10",
  "requirements_submitted": "2024-08-23",
  "start_date": "2024-10-01",
  "end_date": "2024-10-01",
  "requirement_schema": [
    {
      "id": "link",
      "name": "Email Link",
      "type": "text",
      "description": "URL you want embedded into the email for a call to action.",
      "is_required": true
    }
  ],
  "requirement_meta": {
    "link": "http://www.example.com"
  },
  "parent_order": {
    "id": "ABC123",
    "created_at": "2024-08-23 19:10:23.266295+00",
    "updated_at": "2024-08-23 19:24:46.059+00",
    "invoice_id": "in_abc123",
    "payment_date": "2024-08-23"
  },
  "product": {
    "id": "prod_abc123",
    "name": "Phone Outreach for School Fundraisers"
  },
  "package": {
    "id": "pkg_abc123",
    "name": "60 Connections"
  },
  "org": {
    "id": "org_abc123",
    "name": "LOMA"
  },
  "location": {
    "id": "abc123",
    "name": "LOMA HQ",
    "address_line_1": "1234 Main St",
    "address_line_2": null,
    "address_city": "Atlanta",
    "address_state": "Georgia",
    "address_zip": "30303",
    "address_country": "US"
  },
  "kpis": [
    {
      "id": "evJcYq2GgBtdoVxa",
      "name": "Schools Engaged",
      "value": 2,
      "created_at": "2024-08-23T19:10:23.266295+00:00",
      "updated_at": "2024-08-23T19:10:23.266295+00:00"
    },
    {
      "id": "mxhTwZdeIxA2wBUx",
      "name": "Emails Collected",
      "value": null,
      "created_at": "2024-08-23T19:10:23.266295+00:00",
      "updated_at": "2024-08-23T19:10:23.266295+00:00"
    }
  ],
  "results": [
    {
      "id": "res_abc123",
      "title": "connections.csv",
      "created_at": "2024-08-23T19:26:44.583043+00:00",
      "updated_at": "2024-08-23T19:26:44.583043+00:00"
    },
    {
      "id": "res_abc123",
      "title": "headshot.png",
      "created_at": "2024-08-23T19:25:41.605688+00:00",
      "updated_at": "2024-08-23T19:25:41.605688+00:00"
    }
  ]
}

Authorizations

API-Key
string
header
required

API Key for the vendor

Response

200 OK

id
string
required
price
string
required
status
enum<string>
required
Available options:
pending_payment,
pending,
confirmed,
in_progress,
completed,
cancelled
created_at
string
required
updated_at
string
required
requirements_due
string
required
requirements_submitted
string | null
required
start_date
string
required
end_date
string
required
requirement_schema
object[]
required

The requirements schema for the order.

requirement_meta
object
required

The requirements submitted by the customer. Each key should map to a requirement ID.

parent_order
object
required
product
object
required
package
object
required
org
object
required
location
object
required
kpis
object[] | null
required
results
object[] | null
required