KioskOS DevelopersBUILD FOR THE PHYSICAL WORLD
Explore the OS
KioskOS / Platform

Partner API reference

Verified route families for fleet, inventory, sales and deployment. Use the live schema for request bodies and scopes.

Integration guide · Reviewed September 7, 2026

A stable resource vocabulary

The product is a Kiosk. The existing API still uses machines and machineNo. Preserve those resource and field names in integrations.

Read before writing

Start with fleet, inventory and order reads. Confirm ownership and environment before configuring any write integration. This documentation page never sends an API request on your behalf.

Use the live contract

The linked OpenAPI schema is the source for required fields, response models and authorization. Do not infer a universal JavaScript hardware SDK from these HTTP examples.

Route families verified against the live OpenAPI schema
MethodResourcePurpose
GET/api/v1/machinesList authorized Kiosks
GET/api/v1/inventoryInspect inventory
GET/api/v1/ordersRead order history
GET/api/v1/rolloutsInspect rollout records
POST/api/v1/rolloutsCreate an authorized rollout
POST/api/v1/fulfillConfigured fulfillment integration

Continue with the source

Swagger UIOpenAPI JSONRedoc reference

Need a deployment-specific answer? Plan your integration with us.