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

RecVue Orders API

Order and order-line lifecycle (order-to-cash).

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

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against 2 base URLs: https://api.recvue.com/api/v2.0, https://sandbox-api.recvue.com/api/v2.0.

7 operations 4 paths 4 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.recvue.com/api/v2.0
Authentication
OAuth 2.0
Contact
Resource Areas
1

Authentication & Security 1

RecVue Orders API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

Paths & Operations 7

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

Orders 7

Order and order-line lifecycle (order-to-cash).

GET
/orders
Get orders
getOrders 2 params → 200401
POST
/orders
Create order
createOrder body → 200401
GET
/orders/{orderId}
Get order by ID
getOrderById 1 param → 200401
PUT
/orders/{orderId}
Update order
updateOrder 1 param body → 200
DELETE
/orders/{orderId}
Delete order
deleteOrder 1 param → 204
POST
/orders/{orderId}/activate
Activate order
activateOrder 1 param → 200
POST
/orders/{orderId}/terminate
Terminate order
terminateOrder 1 param → 200

Schemas 4

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

OrderLine
object
6 properties
OrderList
object
3 properties
Error
object
2 properties
Order
object
An order. RecVue orders carry hundreds of standard and custom fields; only a representative subset is modeled here.
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

recvue-orders-api-openapi.yml Raw ↑

Other APIs RecVue publishes across the network.

RecVue Authentication API
RecVue Billing API
RecVue Billing Schedules API
RecVue Customers API
RecVue Invoices API
RecVue Pricing API
RecVue Programs API
RecVue Revenue Recognition API
RecVue Usage API