GraphQL queries

Read entry points exposed by the KarmanFlow GraphQL API.

address

address(id: ID!, tenantId: String!): Address

Arguments

  • id: ID!: (no description)
  • tenantId: String!: (no description)

addresses

addresses(kind: String, limit: Int, partyId: ID, status: String, tenantId: String!): [Address!]

Arguments

  • kind: String: (no description)
  • limit: Int: (no description)
  • partyId: ID: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

adminBroadcasts

adminBroadcasts(limit: Int, policyContext: JSON, status: String, tenantId: String!): [AdminBroadcast!]

Arguments

  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

adminUserActivitySessions

adminUserActivitySessions(appInstallationId: String, limit: Int, policyContext: JSON, status: String, tenantId: String!, userId: String): [AdminUserActivitySession!]

Arguments

  • appInstallationId: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)
  • userId: String: (no description)

adminUserActivitySummary

adminUserActivitySummary(policyContext: JSON, tenantId: String!): AdminUserActivitySummary

Arguments

  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

agentDefinition

agentDefinition(definitionId: ID!, includePlatform: Boolean, policyContext: JSON, tenantId: String!): AgentDefinition

Arguments

  • definitionId: ID!: (no description)
  • includePlatform: Boolean: When true, also match platform-scoped (tenant_id IS NULL) definitions by id. Default false; matches the gating on agentDefinitions list.
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

agentDefinitions

agentDefinitions(includePlatform: Boolean, limit: Int, ownerLane: String, policyContext: JSON, status: String, tenantId: String!): [AgentDefinition!]

Arguments

  • includePlatform: Boolean: When true, also return platform-scoped (tenant_id IS NULL) definitions in addition to the caller's tenant rows.
  • limit: Int: (no description)
  • ownerLane: String: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

agentInstallation

agentInstallation(installationId: ID!, policyContext: JSON, tenantId: String!): AgentInstallation

Arguments

  • installationId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

agentInstallations

agentInstallations(agentDefinitionId: String, limit: Int, policyContext: JSON, status: String, tenantId: String!): [AgentInstallation!]

Arguments

  • agentDefinitionId: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

agentRun

agentRun(policyContext: JSON, runId: ID!, tenantId: String!): AgentRun

Arguments

  • policyContext: JSON: (no description)
  • runId: ID!: (no description)
  • tenantId: String!: (no description)

agentRuns

agentRuns(agentId: String, correlationId: String, limit: Int, policyContext: JSON, status: String, tenantId: String!): [AgentRun!]

Arguments

  • agentId: String: (no description)
  • correlationId: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

apiKey

apiKey(apiKeyId: ID!, policyContext: JSON, tenantId: String!): ApiKey

Arguments

  • apiKeyId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

apiKeys

apiKeys(limit: Int, policyContext: JSON, status: String, subjectId: String, subjectType: String, tenantId: String!): [ApiKey!]

Arguments

  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • subjectId: String: (no description)
  • subjectType: String: (no description)
  • tenantId: String!: (no description)

appFeedItems

appFeedItems(appInstallationId: String, feedCategory: String, limit: Int, policyContext: JSON, status: String, tenantId: String!, webSessionId: String): [AppFeedItem!]

Arguments

  • appInstallationId: String: (no description)
  • feedCategory: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)
  • webSessionId: String: (no description)

appInstallation

appInstallation(installationId: ID!, policyContext: JSON, tenantId: String!): AppInstallation

Arguments

  • installationId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

appInstallations

appInstallations(appId: String, limit: Int, partnerOrgId: String, policyContext: JSON, status: String, tenantId: String!): [AppInstallation!]

Arguments

  • appId: String: (no description)
  • limit: Int: (no description)
  • partnerOrgId: String: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

approvalRequests

approvalRequests(entityId: String, entityType: String, limit: Int, policyContext: JSON, requestedAction: String, status: String, tenantId: String!): [ApprovalRequest!]

Arguments

  • entityId: String: (no description)
  • entityType: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • requestedAction: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

availability

Composed availability for a (variant, location). With no availableOn, returns the scalar NodeAvailable only. With availableOn, walks inventory_future_quantities forward to compose NodeAvailable + Σ CONFIRMED.quantity where expected_on <= availableOn for the same scope. segment is reserved for the network-availability projection and ignored today; the field is typed so callers can lock down to the segment they want once the unified surface lands.

availability(availableOn: DateTime, locationId: ID!, segment: String, tenantId: String!, variantId: ID!): AvailabilityResult

Arguments

  • availableOn: DateTime: (no description)
  • locationId: ID!: (no description)
  • segment: String: (no description)
  • tenantId: String!: (no description)
  • variantId: ID!: (no description)

buildContextPack

Build the ContextPack for the current route. The resolver derives RouteContext from the runtime auth context; caller-supplied tenant, environment, actor, or scopes are rejected.

buildContextPack(includeSerialized: Boolean, input: BuildContextPackInput, path: String!, policyContext: JSON): ContextPack

Arguments

  • includeSerialized: Boolean: (no description)
  • input: BuildContextPackInput: (no description)
  • path: String!: (no description)
  • policyContext: JSON: (no description)

businessUnits

businessUnits(environmentId: String, status: String, tenantId: String!): [BusinessUnit!]

Arguments

  • environmentId: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

channelAssignments

channelAssignments(businessUnitId: String, commerceMarketId: String, environmentId: String, scopeKind: String, status: String, tenantId: String!): [ChannelAssignment!]

Arguments

  • businessUnitId: String: (no description)
  • commerceMarketId: String: (no description)
  • environmentId: String: (no description)
  • scopeKind: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

channelAvailabilities

channelAvailabilities(channelId: String, limit: Int, locationId: String, policyContext: JSON, tenantId: String!, variantId: String): [ChannelAvailability!]

Arguments

  • channelId: String: (no description)
  • limit: Int: (no description)
  • locationId: String: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)
  • variantId: String: (no description)

channelAvailabilityExplain

Explain the channel availability for a variant on a specific channel: resolved listing status, applied buffer, and resulting availableToSell. Runs the full composition walk with channelId applied. Requires inventory:read scope.

channelAvailabilityExplain(channelId: ID!, policyContext: JSON, tenantId: String!, variantId: ID!): NetworkAvailability

Arguments

  • channelId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)
  • variantId: ID!: (no description)

channelListings

channelListings(channelId: String, environmentId: String, status: String, tenantId: String!, variantId: String): [ChannelListing!]

Arguments

  • channelId: String: (no description)
  • environmentId: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)
  • variantId: String: (no description)

channelOffers

channelOffers(environmentId: String, listingId: String!, tenantId: String!): [ChannelOffer!]

Arguments

  • environmentId: String: (no description)
  • listingId: String!: (no description)
  • tenantId: String!: (no description)

commandPolicySimulation

commandPolicySimulation(actorId: String!, actorType: String!, commandType: String!, groupIds: [String!], partnerIds: [String!], policyContext: JSON, requestedScopes: [String!], resourceId: String, subjectId: String, subjectType: String, tenantId: String!): CommandPolicySimulation

Arguments

  • actorId: String!: (no description)
  • actorType: String!: (no description)
  • commandType: String!: (no description)
  • groupIds: [String!]: (no description)
  • partnerIds: [String!]: (no description)
  • policyContext: JSON: (no description)
  • requestedScopes: [String!]: (no description)
  • resourceId: String: (no description)
  • subjectId: String: (no description)
  • subjectType: String: (no description)
  • tenantId: String!: (no description)

commandReceipt

commandReceipt(commandId: String!, policyContext: JSON, tenantId: String!): CommandReceipt

Arguments

  • commandId: String!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

commandReceipts

commandReceipts(actorId: String, actorType: String, agentRunId: String, approvalRequestId: String, commandType: String, correlationId: String, entityId: String, entityType: String, limit: Int, policyContext: JSON, skillRunId: String, status: String, tenantId: String!): [CommandReceipt!]

Arguments

  • actorId: String: (no description)
  • actorType: String: (no description)
  • agentRunId: String: (no description)
  • approvalRequestId: String: (no description)
  • commandType: String: (no description)
  • correlationId: String: (no description)
  • entityId: String: (no description)
  • entityType: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • skillRunId: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

commerceMarkets

commerceMarkets(environmentId: String, status: String, tenantId: String!): [CommerceMarket!]

Arguments

  • environmentId: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

compositeAvailability

compositeAvailability(environmentId: String, includeDropship: Boolean, includeSubstitutes: Boolean, tenantId: String!, variantId: String!): CompositeAvailability

Arguments

  • environmentId: String: (no description)
  • includeDropship: Boolean: (no description)
  • includeSubstitutes: Boolean: (no description)
  • tenantId: String!: (no description)
  • variantId: String!: (no description)

connectorBinding

connectorBinding(bindingId: ID!, policyContext: JSON, tenantId: String!): ConnectorBinding

Arguments

  • bindingId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

connectorBindings

connectorBindings(limit: Int, policyContext: JSON, provider: String, status: String, tenantId: String!): [ConnectorBinding!]

Arguments

  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • provider: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

contactPoint

contactPoint(id: ID!, tenantId: String!): ContactPoint

Arguments

  • id: ID!: (no description)
  • tenantId: String!: (no description)

contactPoints

contactPoints(contactType: String, limit: Int, partyId: ID, status: String, tenantId: String!): [ContactPoint!]

Arguments

  • contactType: String: (no description)
  • limit: Int: (no description)
  • partyId: ID: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

controlCenterSnapshot

controlCenterSnapshot(expiringBefore: DateTime, limit: Int, policyContext: JSON, tenantId: String!): ControlCenterSnapshot

Arguments

  • expiringBefore: DateTime: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

customerServiceRequest

customerServiceRequest(id: ID!, policyContext: JSON, tenantId: String!): CustomerServiceRequest

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

customerServiceRequests

customerServiceRequests(limit: Int, policyContext: JSON, requestClass: [String!], state: [String!], tenantId: String!): [CustomerServiceRequest!]

Arguments

  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • requestClass: [String!]: (no description)
  • state: [String!]: (no description)
  • tenantId: String!: (no description)

customFields

customFields(after: String, entityId: String, entityType: String, fieldGroup: String, fieldKey: String, indexedOnly: Boolean, limit: Int, namespace: String, policyContext: JSON, stringEquals: String, tenantId: String!, valueType: String): [CustomField!]

Arguments

  • after: String: (no description)
  • entityId: String: (no description)
  • entityType: String: (no description)
  • fieldGroup: String: (no description)
  • fieldKey: String: (no description)
  • indexedOnly: Boolean: (no description)
  • limit: Int: (no description)
  • namespace: String: (no description)
  • policyContext: JSON: (no description)
  • stringEquals: String: (no description)
  • tenantId: String!: (no description)
  • valueType: String: (no description)

customFieldsConnection

customFieldsConnection(after: String, entityId: String, entityType: String, fieldGroup: String, fieldKey: String, first: Int, indexedOnly: Boolean, namespace: String, policyContext: JSON, stringEquals: String, tenantId: String!, valueType: String): CustomFieldConnection

Arguments

  • after: String: (no description)
  • entityId: String: (no description)
  • entityType: String: (no description)
  • fieldGroup: String: (no description)
  • fieldKey: String: (no description)
  • first: Int: (no description)
  • indexedOnly: Boolean: (no description)
  • namespace: String: (no description)
  • policyContext: JSON: (no description)
  • stringEquals: String: (no description)
  • tenantId: String!: (no description)
  • valueType: String: (no description)

domainEvent

domainEvent(eventId: ID!, policyContext: JSON, tenantId: String!): DomainEvent

Arguments

  • eventId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

domainEvents

domainEvents(afterStreamSequence: String, entityId: String, entityType: String, eventTypeLike: String, limit: Int, occurredAfter: DateTime, occurredBefore: DateTime, policyContext: JSON, streamKey: String, tenantId: String!): [DomainEvent!]

Arguments

  • afterStreamSequence: String: Replay cursor within streamKey. Returns events with streamSequence greater than this value.
  • entityId: String: (no description)
  • entityType: String: (no description)
  • eventTypeLike: String: SQL LIKE pattern, e.g. inventory.reservation.%
  • limit: Int: (no description)
  • occurredAfter: DateTime: (no description)
  • occurredBefore: DateTime: (no description)
  • policyContext: JSON: (no description)
  • streamKey: String: Per-entity event stream key, e.g. InventoryLevel:inv_123
  • tenantId: String!: (no description)

dropshipFeed

dropshipFeed(feedId: String!, tenantId: String!): DropshipFeed

Arguments

  • feedId: String!: (no description)
  • tenantId: String!: (no description)

dropshipFeeds

dropshipFeeds(environmentId: String, tenantId: String!): [DropshipFeed!]

Arguments

  • environmentId: String: (no description)
  • tenantId: String!: (no description)

externalTasks

externalTasks(entityId: String, entityType: String, policyContext: JSON, status: String, tenantId: String!): [ExternalTask!]

Arguments

  • entityId: String: (no description)
  • entityType: String: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

featureActivationMaterialization

featureActivationMaterialization(id: ID!): FeatureActivationMaterialization

Arguments

  • id: ID!: (no description)

featureActivationMaterializations

featureActivationMaterializations(environmentId: String, featureId: String, limit: Int, tenantId: String!): [FeatureActivationMaterialization!]

Arguments

  • environmentId: String: (no description)
  • featureId: String: (no description)
  • limit: Int: (no description)
  • tenantId: String!: (no description)

fulfillmentHolds

fulfillmentHolds(fulfillmentOrderId: ID!, openOnly: Boolean, policyContext: JSON, tenantId: String!): [FulfillmentHold!]

Arguments

  • fulfillmentOrderId: ID!: (no description)
  • openOnly: Boolean: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

fulfillmentOrder

fulfillmentOrder(id: ID!, policyContext: JSON, tenantId: String!): FulfillmentOrder

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

fulfillmentOrderLines

fulfillmentOrderLines(fulfillmentOrderId: ID!, limit: Int, policyContext: JSON, status: String, tenantId: String!): [FulfillmentOrderLine!]

Arguments

  • fulfillmentOrderId: ID!: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

fulfillmentOrders

fulfillmentOrders(limit: Int, orderId: String, policyContext: JSON, sourceLocationId: String, status: String, tenantId: String!): [FulfillmentOrder!]

Arguments

  • limit: Int: (no description)
  • orderId: String: (no description)
  • policyContext: JSON: (no description)
  • sourceLocationId: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

futureSupply

Operator view: future-quantity rows for one (variant, location) in a [from, to] expected_on window. Returns only rows in non-terminal status (PROJECTED, CONFIRMED).

futureSupply(from: DateTime, locationId: ID!, tenantId: String!, to: DateTime, variantId: ID!): [InventoryFutureQuantity!]

Arguments

  • from: DateTime: (no description)
  • locationId: ID!: (no description)
  • tenantId: String!: (no description)
  • to: DateTime: (no description)
  • variantId: ID!: (no description)

futureSupplyTimeline

Support view: full inventory.future.* event history for one source line. Returns events ordered by occurred_on ascending so the row's lifecycle reads top-to-bottom.

futureSupplyTimeline(sourceId: String!, sourceType: String!, tenantId: String!): [FutureSupplyTimelineEntry!]

Arguments

  • sourceId: String!: (no description)
  • sourceType: String!: (no description)
  • tenantId: String!: (no description)

groupAvailability

Aggregate network availability across a named location group for a single variant. Equivalent to networkAvailability with locationGroupId set, exposed as a convenience. Requires inventory:read scope.

groupAvailability(availableOn: String, channelId: String, locationGroupId: ID!, policyContext: JSON, tenantId: String!, variantId: ID!): NetworkAvailability

Arguments

  • availableOn: String: (no description)
  • channelId: String: (no description)
  • locationGroupId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)
  • variantId: ID!: (no description)

incident

incident(id: ID!): Incident

Arguments

  • id: ID!: (no description)

incidents

incidents(after: String, faultClass: [String!], limit: Int, severity: [String!], state: [String!]): IncidentConnection

Arguments

  • after: String: (no description)
  • faultClass: [String!]: (no description)
  • limit: Int: (no description)
  • severity: [String!]: (no description)
  • state: [String!]: (no description)

inventoryCountLines

inventoryCountLines(countSessionId: String!, limit: Int, policyContext: JSON, tenantId: String!): [InventoryCountLine!]

Arguments

  • countSessionId: String!: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

inventoryCountSessions

inventoryCountSessions(limit: Int, locationId: String, policyContext: JSON, status: String, tenantId: String!): [InventoryCountSession!]

Arguments

  • limit: Int: (no description)
  • locationId: String: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

inventoryLevel

inventoryLevel(id: ID!, policyContext: JSON, tenantId: String!): InventoryLevel

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

inventoryLevels

inventoryLevels(inventoryOwnerId: String, limit: Int, locationId: String, offset: Int, policyContext: JSON, tenantId: String!, variantId: String): [InventoryLevel!]

Arguments

  • inventoryOwnerId: String: (no description)
  • limit: Int: (no description)
  • locationId: String: (no description)
  • offset: Int: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)
  • variantId: String: (no description)

inventoryLevelStatusHistory

inventoryLevelStatusHistory(environmentId: String, inventoryLevelId: String!, limit: Int, offset: Int, tenantId: String!): [InventoryLevelStatusTransition!]

Arguments

  • environmentId: String: (no description)
  • inventoryLevelId: String!: (no description)
  • limit: Int: (no description)
  • offset: Int: (no description)
  • tenantId: String!: (no description)

inventoryMetricsDaily

inventoryMetricsDaily(fromDay: String, limit: Int, offset: Int, policyContext: JSON, scope: String, tenantId: String!, toDay: String): [InventoryMetricsDaily!]

Arguments

  • fromDay: String: Inclusive YYYY-MM-DD lower bound
  • limit: Int: (no description)
  • offset: Int: (no description)
  • policyContext: JSON: (no description)
  • scope: String: tenant, location:&lt;id&gt;, variant:&lt;id&gt;, or channel:&lt;key&gt;
  • tenantId: String!: (no description)
  • toDay: String: Inclusive YYYY-MM-DD upper bound

inventoryMetricsLive

inventoryMetricsLive(policyContext: JSON, scope: String, tenantId: String!): InventoryMetricsLive

Arguments

  • policyContext: JSON: (no description)
  • scope: String: tenant, location:&lt;id&gt;, variant:&lt;id&gt;, or channel:&lt;key&gt;
  • tenantId: String!: (no description)

inventoryMetricsTopIssues

inventoryMetricsTopIssues(fromDay: String, includeLive: Boolean, limit: Int, policyContext: JSON, scope: String, tenantId: String!, toDay: String): [InventoryMetricsTopIssue!]

Arguments

  • fromDay: String: Inclusive YYYY-MM-DD lower bound for daily metrics
  • includeLive: Boolean: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • scope: String: tenant, location:&lt;id&gt;, variant:&lt;id&gt;, or channel:&lt;key&gt;
  • tenantId: String!: (no description)
  • toDay: String: Inclusive YYYY-MM-DD upper bound for daily metrics

inventoryMovements

inventoryMovements(inventoryLevelId: String!, limit: Int, tenantId: String!): [InventoryMovement!]

Arguments

  • inventoryLevelId: String!: (no description)
  • limit: Int: (no description)
  • tenantId: String!: (no description)

jobs

jobs(jobType: String, limit: Int, policyContext: JSON, scheduleId: String, status: String, tenantId: String!): [Job!]

Arguments

  • jobType: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • scheduleId: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

jobSchedule

jobSchedule(policyContext: JSON, scheduleId: ID!, tenantId: String!): JobSchedule

Arguments

  • policyContext: JSON: (no description)
  • scheduleId: ID!: (no description)
  • tenantId: String!: (no description)

jobSchedules

jobSchedules(jobType: String, limit: Int, policyContext: JSON, status: String, tenantId: String!): [JobSchedule!]

Arguments

  • jobType: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

latestFeatureActivationMaterialization

latestFeatureActivationMaterialization(environmentId: String, featureId: String!, tenantId: String!): FeatureActivationMaterialization

Arguments

  • environmentId: String: (no description)
  • featureId: String!: (no description)
  • tenantId: String!: (no description)

location

location(id: ID!, tenantId: String!): Location

Arguments

  • id: ID!: (no description)
  • tenantId: String!: (no description)

locations

locations(status: String, tenantId: String!): [Location!]

Arguments

  • status: String: (no description)
  • tenantId: String!: (no description)

metricDefinitionValues

metricDefinitionValues(fromDay: String, granularity: String, limit: Int, metricKey: String, policyContext: JSON, scope: String, tenantId: String!, toDay: String): [MetricDefinitionValue!]

Arguments

  • fromDay: String: Inclusive YYYY-MM-DD lower bound.
  • granularity: String: HOURLY, DAILY, WEEKLY, or MONTHLY.
  • limit: Int: (no description)
  • metricKey: String: (no description)
  • policyContext: JSON: (no description)
  • scope: String: tenant, location:&lt;id&gt;, variant:&lt;id&gt;, or channel:&lt;key&gt;.
  • tenantId: String!: (no description)
  • toDay: String: Inclusive YYYY-MM-DD upper bound.

myProgressiveActions

myProgressiveActions(limit: Int, policyContext: JSON, tenantId: String!): [ProgressiveAction!]

Arguments

  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

networkAvailability

Compose the six-layer derivation tree into one availability answer for a single variant. Requires inventory:read scope. Pass includeIneligibleNodes: true (inventory:debug scope) for ops debugging.

networkAvailability(availableOn: String, channelId: String, customerTierId: String, includeAccountAllocation: Boolean, includeDropship: Boolean, includeIneligibleNodes: Boolean, includeSubstitutes: Boolean, locationGroupId: String, marketId: String, policyContext: JSON, tenantId: String!, variantId: ID!): NetworkAvailability

Arguments

  • availableOn: String: (no description)
  • channelId: String: (no description)
  • customerTierId: String: (no description)
  • includeAccountAllocation: Boolean: (no description)
  • includeDropship: Boolean: (no description)
  • includeIneligibleNodes: Boolean: (no description)
  • includeSubstitutes: Boolean: (no description)
  • locationGroupId: String: (no description)
  • marketId: String: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)
  • variantId: ID!: (no description)

openProgressiveActions

openProgressiveActions(limit: Int, moduleSlot: String!, policyContext: JSON, tenantId: String!): [ProgressiveAction!]

Arguments

  • limit: Int: (no description)
  • moduleSlot: String!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

order

order(id: ID!, policyContext: JSON, tenantId: String!): Order

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

orderDiscounts

orderDiscounts(orderId: ID!, policyContext: JSON, tenantId: String!): [OrderDiscount!]

Arguments

  • orderId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

orderLineDiscounts

orderLineDiscounts(orderLineId: ID!, policyContext: JSON, tenantId: String!): [OrderLineDiscount!]

Arguments

  • orderLineId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

orderLineProperties

orderLineProperties(orderLineId: ID!, policyContext: JSON, tenantId: String!): [OrderLineProperty!]

Arguments

  • orderLineId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

orderLines

orderLines(limit: Int, orderId: String!, policyContext: JSON, tenantId: String!): [OrderLine!]

Arguments

  • limit: Int: (no description)
  • orderId: String!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

orderLineTaxLines

orderLineTaxLines(orderLineId: ID!, policyContext: JSON, tenantId: String!): [OrderLineTaxLine!]

Arguments

  • orderLineId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

orderNotes

orderNotes(orderId: ID!, policyContext: JSON, tenantId: String!): [OrderNote!]

Arguments

  • orderId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

orders

orders(channelId: String, limit: Int, offset: Int, policyContext: JSON, status: String, tenantId: String!): [Order!]

Arguments

  • channelId: String: (no description)
  • limit: Int: (no description)
  • offset: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

parties

parties(limit: Int, partyType: String, policyContext: JSON, status: String, tenantId: String!): [Party!]

Arguments

  • limit: Int: (no description)
  • partyType: String: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

partiesByIds

partiesByIds(ids: [ID!]!, policyContext: JSON, tenantId: String!): [Party!]

Arguments

  • ids: [ID!]!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

party

party(id: ID!, policyContext: JSON, tenantId: String!): Party

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

partyRole

partyRole(id: ID!, policyContext: JSON, tenantId: String!): PartyRole

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

partyRoles

partyRoles(limit: Int, partyId: ID, policyContext: JSON, roleType: String, scopeId: ID, scopeType: String, status: String, tenantId: String!): [PartyRole!]

Arguments

  • limit: Int: (no description)
  • partyId: ID: (no description)
  • policyContext: JSON: (no description)
  • roleType: String: (no description)
  • scopeId: ID: (no description)
  • scopeType: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

ping

ping: String

previewLotAllocation

previewLotAllocation(inventoryOwnerId: String!, locationId: String!, lotAllocationPolicyId: String, lotAllocationStrategy: String, metadata: CommandMetadataInput!, policyContext: JSON, quantity: Float!, tenantId: String!, variantId: String!): LotAllocationPreview

Arguments

  • inventoryOwnerId: String!: (no description)
  • locationId: String!: (no description)
  • lotAllocationPolicyId: String: (no description)
  • lotAllocationStrategy: String: (no description)
  • metadata: CommandMetadataInput!: (no description)
  • policyContext: JSON: (no description)
  • quantity: Float!: (no description)
  • tenantId: String!: (no description)
  • variantId: String!: (no description)

product

product(id: ID!, tenantId: String!): Product

Arguments

  • id: ID!: (no description)
  • tenantId: String!: (no description)

productPublications

productPublications(policyContext: JSON, productId: ID!, tenantId: String!): [ProductPublication!]

Arguments

  • policyContext: JSON: (no description)
  • productId: ID!: (no description)
  • tenantId: String!: (no description)

products

products(status: String, tenantId: String!): [Product!]

Arguments

  • status: String: (no description)
  • tenantId: String!: (no description)

productSeo

productSeo(policyContext: JSON, productId: ID!, tenantId: String!): [ProductSeo!]

Arguments

  • policyContext: JSON: (no description)
  • productId: ID!: (no description)
  • tenantId: String!: (no description)

productVariant

productVariant(id: ID!, tenantId: String!): ProductVariant

Arguments

  • id: ID!: (no description)
  • tenantId: String!: (no description)

productVariantDimensions

productVariantDimensions(policyContext: JSON, tenantId: String!, variantId: ID!): ProductVariantDimensions

Arguments

  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)
  • variantId: ID!: (no description)

productVariantFulfillmentPolicies

productVariantFulfillmentPolicies(policyContext: JSON, tenantId: String!, variantId: ID!): [ProductVariantFulfillmentPolicy!]

Arguments

  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)
  • variantId: ID!: (no description)

productVariants

productVariants(limit: Int, skuLike: String, status: String, tenantId: String!): [ProductVariant!]

Arguments

  • limit: Int: (no description)
  • skuLike: String: SQL LIKE pattern
  • status: String: (no description)
  • tenantId: String!: (no description)

progressiveAction

progressiveAction(id: ID!, policyContext: JSON, tenantId: String!): ProgressiveAction

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

progressiveActionsAwaitingApproval

progressiveActionsAwaitingApproval(limit: Int, policyContext: JSON, tenantId: String!): [ProgressiveAction!]

Arguments

  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

progressiveActionSteps

progressiveActionSteps(actionId: ID!, policyContext: JSON, tenantId: String!): [ProgressiveActionStep!]

Arguments

  • actionId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

publicationAttempts

publicationAttempts(eventId: String, limit: Int, policyContext: JSON, status: String, tenantId: String!): [PublicationAttempt!]

Arguments

  • eventId: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

reconciliationDecisions

reconciliationDecisions(limit: Int, reconciliationDifferenceId: String, status: String, tenantId: String!): [InventoryReconciliationDecision!]

Arguments

  • limit: Int: (no description)
  • reconciliationDifferenceId: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

reconciliationDifferences

reconciliationDifferences(inventoryLevelId: String, limit: Int, locationId: String, reconciliationSessionId: String, status: String, tenantId: String!, thresholdClass: String): [InventoryReconciliationDifference!]

Arguments

  • inventoryLevelId: String: (no description)
  • limit: Int: (no description)
  • locationId: String: (no description)
  • reconciliationSessionId: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)
  • thresholdClass: String: (no description)

reconciliationSessions

reconciliationSessions(limit: Int, sourceType: String, status: String, tenantId: String!): [InventoryReconciliationSession!]

Arguments

  • limit: Int: (no description)
  • sourceType: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

refundLineItems

refundLineItems(policyContext: JSON, refundId: ID!, tenantId: String!): [RefundLineItem!]

Arguments

  • policyContext: JSON: (no description)
  • refundId: ID!: (no description)
  • tenantId: String!: (no description)

reservation

reservation(id: ID!, policyContext: JSON, tenantId: String!): Reservation

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

reservations

reservations(expiringBefore: DateTime, limit: Int, policyContext: JSON, status: String, tenantId: String!): [Reservation!]

Arguments

  • expiringBefore: DateTime: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

reservationsByOrderId

reservationsByOrderId(orderId: String!, policyContext: JSON, tenantId: String!): [Reservation!]

Arguments

  • orderId: String!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

resolvedChannelAssignment

resolvedChannelAssignment(businessUnitId: String, commerceMarketId: String, environmentId: String, salesChannelId: String, tenantId: String!): ResolvedChannelAssignment

Arguments

  • businessUnitId: String: (no description)
  • commerceMarketId: String: (no description)
  • environmentId: String: (no description)
  • salesChannelId: String: (no description)
  • tenantId: String!: (no description)

resolvedOffer

resolvedOffer(at: String, currency: String!, listingId: String!, tenantId: String!): ResolvedOffer

Arguments

  • at: String: (no description)
  • currency: String!: (no description)
  • listingId: String!: (no description)
  • tenantId: String!: (no description)

return

return(id: ID!, policyContext: JSON, tenantId: String!): Return

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

returns

returns(limit: Int, orderId: String, policyContext: JSON, status: String, tenantId: String!): [Return!]

Arguments

  • limit: Int: (no description)
  • orderId: String: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

salesChannel

salesChannel(id: ID!, policyContext: JSON, tenantId: String!): SalesChannel

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

salesChannels

salesChannels(limit: Int, policyContext: JSON, status: String, tenantId: String!): [SalesChannel!]

Arguments

  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

serverInfo

serverInfo: ServerInfo!

shipment

shipment(id: ID!, policyContext: JSON, tenantId: String!): Shipment

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

shipments

shipments(fulfillmentOrderId: ID, limit: Int, policyContext: JSON, status: String, tenantId: String!): [Shipment!]

Arguments

  • fulfillmentOrderId: ID: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

stockTransfer

stockTransfer(id: ID!, policyContext: JSON, tenantId: String!): StockTransfer

Arguments

  • id: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

stockTransfers

stockTransfers(limit: Int, policyContext: JSON, status: String, tenantId: String!): [StockTransfer!]

Arguments

  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

substituteGroups

substituteGroups(channelId: String, environmentId: String, tenantId: String!, variantId: String): [SubstituteGroup!]

Arguments

  • channelId: String: (no description)
  • environmentId: String: (no description)
  • tenantId: String!: (no description)
  • variantId: String: (no description)

substituteMembers

substituteMembers(groupId: String!, tenantId: String!): [SubstituteMember!]

Arguments

  • groupId: String!: (no description)
  • tenantId: String!: (no description)

tenantAnalyticsExports

List the calling tenant's analytics_export rows. PLATFORM-scope rows are never returned through this query; they are reachable only through staff-realm surfaces. Filter optionally by status (REQUESTED | RUNNING | COMPLETED | FAILED). page.limit is capped at 100; page.offset is zero-indexed.

tenantAnalyticsExports(limit: Int, offset: Int, status: String, tenantId: String!): [AnalyticsExport!]

Arguments

  • limit: Int: (no description)
  • offset: Int: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

tenantConfig

tenantConfig(configKey: String!, policyContext: JSON, tenantId: String!): TenantConfig

Arguments

  • configKey: String!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

tenantConfigCatalog

tenantConfigCatalog(extensionSafe: Boolean, scope: String, visibility: String): [TenantConfigDefinition!]

Arguments

  • extensionSafe: Boolean: (no description)
  • scope: String: (no description)
  • visibility: String: (no description)

tenantConfigHistory

tenantConfigHistory(configKey: String!, limit: Int, policyContext: JSON, tenantId: String!): [TenantConfigHistory!]

Arguments

  • configKey: String!: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • tenantId: String!: (no description)

tenantConfigModule

tenantConfigModule(scope: String!): TenantConfigModule

Arguments

  • scope: String!: (no description)

tenantConfigModules

tenantConfigModules: [TenantConfigModule!]

tenantConfigs

tenantConfigs(includeUnknown: Boolean, limit: Int, policyContext: JSON, scope: String, tenantId: String!): [TenantConfig!]

Arguments

  • includeUnknown: Boolean: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • scope: String: (no description)
  • tenantId: String!: (no description)

tenantDeployments

tenantDeployments(environmentId: String, status: String, tenantId: String!): [TenantDeployment!]

Arguments

  • environmentId: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

tenantEnvironments

tenantEnvironments(environmentType: String, status: String, tenantId: String!): [TenantEnvironment!]

Arguments

  • environmentType: String: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

traceReport

traceReport(input: TraceReportInput!): TraceReportResult!

Arguments

  • input: TraceReportInput!: tenant, environment, correlation, trace, command, entity, service, status, and time-window selectors.

traceReportJob

traceReportJob(input: TraceReportInput!): TraceReportJob!

Arguments

  • input: TraceReportInput!: same selector shape as traceReport.

tenantFlowTrace

tenantFlowTrace(commandId: ID, correlationId: String, environmentId: String, fulfillmentOrderId: ID, ingestionRunId: ID, inventoryLevelId: ID, limit: Int, orderId: ID, policyContext: JSON, reservationId: ID, tenantId: ID!): FlowTraceResult!

Arguments

  • commandId: ID: (no description)
  • correlationId: String: (no description)
  • environmentId: String: (no description)
  • fulfillmentOrderId: ID: (no description)
  • ingestionRunId: ID: (no description)
  • inventoryLevelId: ID: (no description)
  • limit: Int: (no description)
  • orderId: ID: (no description)
  • policyContext: JSON: (no description)
  • reservationId: ID: (no description)
  • tenantId: ID!: (no description)

tenantInventoryMetricsBuckets

tenantInventoryMetricsBuckets(bucketEnd: DateTime, bucketStart: DateTime, environmentId: String, granularity: String, limit: Int, offset: Int, policyContext: JSON, scope: String, tenantId: String!): [TenantInventoryMetricsBucket!]

Arguments

  • bucketEnd: DateTime: Inclusive upper bound on bucket_start.
  • bucketStart: DateTime: Inclusive lower bound on bucket_start.
  • environmentId: String: Defaults to prod when omitted.
  • granularity: String: HOURLY, DAILY (default), WEEKLY, or MONTHLY.
  • limit: Int: (no description)
  • offset: Int: (no description)
  • policyContext: JSON: (no description)
  • scope: String: tenant, location:&lt;id&gt;, variant:&lt;id&gt;, or channel:&lt;key&gt;.
  • tenantId: String!: (no description)

tenantInventorySnapshot

tenantInventorySnapshot(includeArchivedVariants: Boolean, locationId: ID!, policyContext: JSON, tenantId: ID!, topN: Int): InventorySnapshot!

Arguments

  • includeArchivedVariants: Boolean: (no description)
  • locationId: ID!: (no description)
  • policyContext: JSON: (no description)
  • tenantId: ID!: (no description)
  • topN: Int: (no description)

tenantOnboardingProgress

tenantOnboardingProgress(environmentId: ID!, tenantId: ID!): OnboardingProgressView

Arguments

  • environmentId: ID!: (no description)
  • tenantId: ID!: (no description)

tenantOrderLookup

tenantOrderLookup(environmentId: String, orderId: ID!, policyContext: JSON, recentEventsPerShipment: Int, tenantId: ID!): OrderLookupResult!

Arguments

  • environmentId: String: (no description)
  • orderId: ID!: (no description)
  • policyContext: JSON: (no description)
  • recentEventsPerShipment: Int: (no description)
  • tenantId: ID!: (no description)

tenantRealtimeGauge

tenantRealtimeGauge(environmentId: String, metricKey: String!, policyContext: JSON, scopeId: String, scopeKind: String!, tenantId: String!): TenantRealtimeGaugeValue

Arguments

  • environmentId: String: Defaults to prod when omitted.
  • metricKey: String!: (no description)
  • policyContext: JSON: (no description)
  • scopeId: String: Scope identifier; for scopeKind=tenant pass _tenant or omit.
  • scopeKind: String!: tenant, location, variant, or channel.
  • tenantId: String!: (no description)

tenantSavedReports

List ACTIVE SavedReport rows for a tenant + surface. Gated by analytics.report:read. Ordered by most recent updated_on; tombstoned rows are filtered out.

tenantSavedReports(environmentId: String, includeDeleted: Boolean, limit: Int, policyContext: JSON, surface: String!, tenantId: String!): [SavedReport!]

Arguments

  • environmentId: String: Defaults to the active environment when omitted.
  • includeDeleted: Boolean: When true, returns tombstoned rows as well. Defaults to false.
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • surface: String!: tenant or staff. Tenant-side surface only in slice 4.
  • tenantId: String!: (no description)

tenantShipmentFeed

tenantShipmentFeed(cursor: String, environmentId: String, limit: Int, policyContext: JSON, tenantId: ID!): ShipmentFeedPage!

Arguments

  • cursor: String: (no description)
  • environmentId: String: (no description)
  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • tenantId: ID!: (no description)

transactions

transactions(limit: Int, paymentIntentId: ID, policyContext: JSON, refundId: ID, tenantId: String!): [Transaction!]

Arguments

  • limit: Int: (no description)
  • paymentIntentId: ID: (no description)
  • policyContext: JSON: (no description)
  • refundId: ID: (no description)
  • tenantId: String!: (no description)

usageEvents

usageEvents(billingExportStatus: String, limit: Int, meter: String, occurredAfter: DateTime, occurredBefore: DateTime, policyContext: JSON, resourceId: String, resourceKind: String, source: String, subjectId: String, subjectType: String, tenantId: String!): [UsageEvent!]

Arguments

  • billingExportStatus: String: (no description)
  • limit: Int: (no description)
  • meter: String: (no description)
  • occurredAfter: DateTime: (no description)
  • occurredBefore: DateTime: (no description)
  • policyContext: JSON: (no description)
  • resourceId: String: (no description)
  • resourceKind: String: (no description)
  • source: String: (no description)
  • subjectId: String: (no description)
  • subjectType: String: (no description)
  • tenantId: String!: (no description)

usageSummary

usageSummary(billingExportStatus: String, meter: String, occurredAfter: DateTime, occurredBefore: DateTime, policyContext: JSON, resourceId: String, resourceKind: String, source: String, subjectId: String, subjectType: String, tenantId: String!): [UsageSummary!]

Arguments

  • billingExportStatus: String: (no description)
  • meter: String: (no description)
  • occurredAfter: DateTime: (no description)
  • occurredBefore: DateTime: (no description)
  • policyContext: JSON: (no description)
  • resourceId: String: (no description)
  • resourceKind: String: (no description)
  • source: String: (no description)
  • subjectId: String: (no description)
  • subjectType: String: (no description)
  • tenantId: String!: (no description)

webhookDeliveries

webhookDeliveries(limit: Int, policyContext: JSON, subscriptionId: String!, tenantId: String!): [WebhookDelivery!]

Arguments

  • limit: Int: (no description)
  • policyContext: JSON: (no description)
  • subscriptionId: String!: (no description)
  • tenantId: String!: (no description)

webhookSubscriptions

webhookSubscriptions(policyContext: JSON, status: String, tenantId: String!): [WebhookSubscription!]

Arguments

  • policyContext: JSON: (no description)
  • status: String: (no description)
  • tenantId: String!: (no description)

workflowMarkers

workflowMarkers(entityId: String, entityType: String, environmentId: String, limit: Int, markerKey: String, markerKeyPrefix: String, offset: Int, policyContext: JSON, status: String, tenantId: String!): [WorkflowMarker!]

Arguments

  • entityId: String: Owner entity id. Filtering by entityId without entityType is allowed but typically paired with one.
  • entityType: String: Owner entity type, e.g. InventoryLevel.
  • environmentId: String: Defaults to the session environment, then to prod.
  • limit: Int: (no description)
  • markerKey: String: Exact marker_key match, e.g. ext:com.acme.quality.qa_pending.
  • markerKeyPrefix: String: Match marker_key LIKE &lt;prefix&gt;%. Applied in addition to markerKey when both are supplied.
  • offset: Int: (no description)
  • policyContext: JSON: (no description)
  • status: String: OPEN or RESOLVED. Omit to return both.
  • tenantId: String!: (no description)
Privacy choices

This controls app-managed marketing analytics: cookie-free Plausible, optional Cloudflare Web Analytics, and first-party event logs with session-only UTM attribution. The site works without it.

Read the privacy notice