Skip to main content
GET
/
api
/
vendor
/
v1
/
orders
List orders
curl --request GET \
  --url https://console.lomaplatform.com/api/vendor/v1/orders \
  --header 'API-Key: <api-key>'
[
  {
    "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",
    "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"
    }
  }
]

Authorizations

​
API-Key
string
header
required

API Key for the vendor

Query Parameters

​
page
number
default:1
​
page_size
number
default:100
Required range: x <= 1000
​
status
enum<string>
Available options:
pending_payment,
pending,
confirmed,
in_progress,
completed,
cancelled

Response

200 - application/json

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
​
parent_order
object
required
​
product
object
required
​
package
object
required
​
org
object
required
​
location
object
required
Example:
[
  {
    "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",
    "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"
    }
  }
]