Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Revel Systems Orders API

Order and order-item resources.

Revel Systems Orders API is one of 6 APIs that Revel Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, a changelog, and 8 JSON Schemas.

This API exposes 4 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 2025.3.0.

Requests are made against 2 base URLs: https://{subdomain}.revelup.com/resources, https://api-sandbox-revel.revelup.com/resources.

4 operations 2 paths 3 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2025.3.0
Base URL
https://yoursubdomain.revelup.com/resources
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Revel Systems Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as API-AUTHENTICATION (apiAuthentication). By default, every request must be authenticated.

  • apiAuthentication — API key and secret joined by a colon, e.g. API-AUTHENTICATION: key:secret. The key and secret may alternatively be passed as apikey and apisecret query paramet…

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 4

Order and order-item resources.

GET
/Order/
Get Orders
getOrders 12 params → 200401429
POST
/Order/
Create Order
createOrder body → 201401429
GET
/Order/{id}/
Get Order
getOrder 2 params → 200401404
PATCH
/Order/{id}/
Update Order
updateOrder 1 param body → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Order (22 properties), Meta (5 properties), OrderList (2 properties). Each schema is shown below with its type and property counts.

Meta
object
Tastypie pagination envelope.
5 properties
OrderList
object
2 properties
Order
object
22 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

revel-systems-orders-api-openapi.yml Raw ↑

Other APIs Revel Systems publishes across the network.

Revel Webhooks
Revel Systems Customers API
Revel Systems Establishments API
Revel Systems Products API
Revel Systems Scheduling API