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

Quartzy Order Requests API

Procurement requests moving through Quartzy's ordering workflow.

Quartzy Order Requests API is one of 6 APIs that Quartzy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://api.quartzy.com.

4 operations 2 paths 7 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.quartzy.com
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Quartzy Order Requests API declares 2 security schemes for authenticating requests. An API key is passed in the header as Access-Token (accessToken). It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

  • accessToken — Per-user AccessToken generated in Quartzy under Profile Access Tokens and sent in the Access-Token header.
  • oauth2 — OAuth2 authorization for Quartzy API access.

Paths & Operations 4

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

Order Requests 4

Procurement requests moving through Quartzy's ordering workflow.

GET
/order-requests
List order requests
listOrderRequests 2 params → 200401
POST
/order-requests
Create an order request
createOrderRequest body → 201401422
GET
/order-requests/{id}
Retrieve an order request
getOrderRequest 1 param → 200401404
PUT
/order-requests/{id}
Update an order request status
updateOrderRequest 1 param body → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are OrderRequest (12 properties), OrderRequestCreate (8 properties), User (4 properties), Type (3 properties). Each schema is shown below with its type and property counts.

Type
object
3 properties
User
object
4 properties
OrderRequestCreate
object
8 properties 2 required
Error
object
2 properties
OrderRequestUpdate
object
1 property 1 required
OrderRequest
object
12 properties
Price
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quartzy-order-requests-api-openapi.yml Raw ↑

Other APIs Quartzy publishes across the network.

Quartzy Inventory Items API
Quartzy Labs API
Quartzy Types API
Quartzy User API
Quartzy Webhooks API