API
GraphQL for reads and writes.
One typed contract for inventory, orders, reservations, and connectors. Queries return the same data the operator console reads. Mutations wrap the command envelope; every write produces a receipt.
What it does
Three things this surface gives you.
- Queries: inventory levels, ATP by channel, reservations, orders, fulfillment, returns, transfers.
- Mutations wrap the typed command envelope with policy checks and idempotency.
- Every write returns a receipt id you can replay through /developers/events.
Create reservation mutation
Worked example.
mutation CreateReservation(
$tenantId: String!,
$variantId: String!,
$locationId: ID!,
$inventoryOwnerId: String!,
$expectedInventoryLevelVersion: Int!,
$quantity: Float!,
$metadata: CommandMetadataInput!
) {
createReservation(input: {
tenantId: $tenantId,
variantId: $variantId,
locationId: $locationId,
inventoryOwnerId: $inventoryOwnerId,
quantity: $quantity,
reservationType: "ORDER",
expectedInventoryLevelVersion: $expectedInventoryLevelVersion,
metadata: $metadata
}) {
reservationId
commandId
currentStatus
}
}Continue inside the hosted KarmanFlow docs for the schema reference, explorer, runtime notes, and preview setup guidance.
Open hosted schema mapPreview
Run a working integration path.
Request a guided preview workspace, or bring a sample integration shape to a working session and we will walk through it on a call.