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 Inventory Items API

Lab inventory items and their physical instances.

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

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

This API exposes 4 operations across 3 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 3 paths 7 schemas 2 GET2 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 Inventory Items 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 3 paths, the API surfaces 4 operations — 2 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Inventory Items 4

Lab inventory items and their physical instances.

GET
/inventory-items
List inventory items
listInventoryItems 2 params → 200401
GET
/inventory-items/{id}
Retrieve an inventory item
getInventoryItem 1 param → 200401404
PUT
/inventory-items/{id}deprecated
Update an inventory item quantity (deprecated)
updateInventoryItem 1 param body → 200401404
PUT
/inventory-items/{itemId}/instances/{itemInstanceId}
Update an item instance quantity
updateInventoryItemInstance 2 params body → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are InventoryItem (11 properties), ItemInstance (6 properties), Type (3 properties), Price (2 properties). Each schema is shown below with its type and property counts.

Type
object
3 properties
ItemInstanceUpdate
object
1 property 1 required
Error
object
2 properties
InventoryItemUpdate
object
1 property
InventoryItem
object
11 properties
ItemInstance
object
6 properties
Price
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quartzy-inventory-items-api-openapi.yml Raw ↑

Other APIs Quartzy publishes across the network.

Quartzy Labs API
Quartzy Order Requests API
Quartzy Types API
Quartzy User API
Quartzy Webhooks API