# KarmanFlow full public reference

This file exports the generated public developer reference as plain text for
agent crawlers, IDE assistants, and LLM retrieval systems. Prefer /llms.txt
for the short curated index; use this file when you need the complete public
GraphQL and kf CLI reference.

Source index: https://www.karmanflow.com/developers/reference

## KarmanFlow developer reference

URL: https://www.karmanflow.com/developers/reference
Summary: Hosted GraphQL and kf CLI reference for KarmanFlow preview builders.

# Developer reference

Hosted reference for the public preview surfaces. Use the explorer when a preview endpoint is configured, the schema map for relationships, and the CLI reference for tenant-safe inspection commands.

## Start here

- [GraphQL explorer](/developers/explorer): inspect the configured preview endpoint when one is available.
- [Schema map](/developers/reference/graphql/schema-map): inspect the graph visually.
- [GraphQL reference](/developers/reference/graphql): browse queries, mutations, object types, inputs, and scalars.
- [CLI reference](/developers/reference/cli): every `kf` topic and action.

---

## kf CLI reference

URL: https://www.karmanflow.com/developers/reference/cli
Summary: Protocol snapshot for the planned kf CLI.

# kf CLI reference

Protocol snapshot for preview builders. The split repos do not currently ship
a canonical `kf` binary package, so these commands are reference content until
the executable lands with release proof.

## Global flags

- `--pretty`: Pretty-print JSON output. Default is single-line JSON.
- `--profile `: Select a local CLI profile other than the active one. Profiles are stored under ~/.config/karmanflow/cli.json.

## Topics

- [`kf version`](/developers/reference/cli/version): Print CLI version metadata.
- [`kf bootstrap`](/developers/reference/cli/bootstrap): Render and write Day-0 tenant bootstrap bundles.
- [`kf commands`](/developers/reference/cli/commands): Inspect the command registry.
- [`kf events`](/developers/reference/cli/events): Read recent domain events.
- [`kf receipts`](/developers/reference/cli/receipts): Read command receipts.
- [`kf auth`](/developers/reference/cli/auth): Authentication helpers.
- [`kf login`](/developers/reference/cli/login): Save GraphQL endpoint and credentials to the active profile.
- [`kf logout`](/developers/reference/cli/logout): Clear the OAuth credentials and OAuth profile previews.
- [`kf profile`](/developers/reference/cli/profile): Manage local CLI profiles.
- [`kf inventory`](/developers/reference/cli/inventory): Inspect and adjust inventory.
- [`kf reservation`](/developers/reference/cli/reservation): Manage reservations on the inventory hot path.
- [`kf fulfillment`](/developers/reference/cli/fulfillment): Manage fulfillment orders.
- [`kf feed`](/developers/reference/cli/feed): Manage app feed deliveries and admin broadcasts.
- [`kf issues`](/developers/reference/cli/issues): Read and acknowledge readable Issues from the local file Issue store.
- [`kf trace`](/developers/reference/cli/trace): Read bounded inventory-to-order proof packets.
- [`kf control-center`](/developers/reference/cli/control-center): Read the tenant Control Center cockpit snapshot.
- [`kf agent`](/developers/reference/cli/agent): Install, suspend, resume, and scope tenant-bound agents.
- [`kf alert`](/developers/reference/cli/alert): Define alert rules, acknowledge triggers, and manage analytics alerts.
- [`kf connector`](/developers/reference/cli/connector): Install, configure, rotate, and replay tenant connectors.
- [`kf feature`](/developers/reference/cli/feature): Install or disable feature modules and apps for the tenant.
- [`kf file-drop`](/developers/reference/cli/file-drop): Register and operate file-drop bindings for batch ingestion.
- [`kf identity`](/developers/reference/cli/identity): Create parties, addresses, and contact points for the tenant.
- [`kf incident`](/developers/reference/cli/incident): Open, triage, escalate, acknowledge, and resolve incidents.
- [`kf ingestion`](/developers/reference/cli/ingestion): Open, submit, and commit ingestion runs and source authorities.
- [`kf onboarding`](/developers/reference/cli/onboarding): Drive the persona-led onboarding flow and aha moments.
- [`kf schedule`](/developers/reference/cli/schedule): Create, pause, resume, and cancel tenant job schedules.
- [`kf tenant-defaults`](/developers/reference/cli/tenant-defaults): Configure persona-driven tenant defaults.
- [`kf tenant`](/developers/reference/cli/tenant): Manage tenant config, locations, API keys, broadcasts, and feeds.
- [`kf webhook`](/developers/reference/cli/webhook): Subscribe to, pause, replay, and rotate webhook deliveries.

---

## kf agent

URL: https://www.karmanflow.com/developers/reference/cli/agent
Summary: Install, suspend, resume, and scope tenant-bound agents.

# kf agent

Install, suspend, resume, and scope tenant-bound agents.

## kf agent grant-scope

Grant additional scope strings to an active agent installation, unioning the new scopes into capability_grant.scopes and emitting agent.scope.granted.

Grant additional scope strings to an active agent installation, unioning the new scopes into capability_grant.scopes and emitting agent.scope.granted. Idempotent on (tenantId, environmentId, command_type, idempotencyKey); requested scopes that are already a subset of the existing grant return reason 'no_op' and do not re-emit. PAUSED, REVOKED, EXPIRED, or PENDING installations soft-fail with reason 'installation_not_active'. Unresolvable targets soft-fail with reason 'installation_not_found'. Risk class R3 per the H2 hardening plan because adding scope widens the agent's authority surface; the H5 approval-binding work layers (commandType, resourceId=installationId, scope, ttl) binding on top.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--target ` | yes | Target. |
| `--scopes ` | yes | Scopes. |
| `--reason ` | no | Reason. |

**Example**

kf agent grant-scope --tenant tnt_demo --actor-type USER --actor-id usr_sam --target  --scopes 

## kf agent install

Install an agent definition into a tenant environment.

Install an agent definition into a tenant environment. Idempotent on (tenantId, environmentId, agentDefinitionId); an ACTIVE row is returned unchanged on re-install. Soft-fails with reason 'agent_definition_not_found' when the referenced definition row is missing so onboarding in a fresh DB does not break. Risk class R3 because the installation grants agent authority.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--agent-definition-id ` | yes | Agent definition id. |
| `--mode ` | no | Mode. |
| `--capability-grant ` | no | Capability grant. |

**Example**

kf agent install --tenant tnt_demo --actor-type USER --actor-id usr_sam --agent-definition-id 

## kf agent resume

Resume a paused agent installation, flipping its status from PAUSED to ACTIVE and emitting agent.resume.applied.

Resume a paused agent installation, flipping its status from PAUSED to ACTIVE and emitting agent.resume.applied. Companion to SuspendAgent. Idempotent on (tenantId, environmentId, command_type, idempotencyKey); an already-ACTIVE row replays without re-emitting; PENDING rows soft-fail with reason 'not_paused'; REVOKED/EXPIRED rows soft-fail with reason 'terminal_status'. Risk class R2 per the H2 hardening plan because Resume restores authority paused by an operator. The 'fresh approval if last suspend was a security review' gate ships with the H5 approval-binding work.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--target ` | yes | Target. |
| `--reason ` | no | Reason. |

**Example**

kf agent resume --tenant tnt_demo --actor-type USER --actor-id usr_sam --target 

## kf agent revoke-scope

Revoke scope strings from an agent installation, subtracting them from capability_grant.scopes and emitting agent.scope.revoked.

Revoke scope strings from an agent installation, subtracting them from capability_grant.scopes and emitting agent.scope.revoked. Companion to GrantAgentScope. Idempotent on (tenantId, environmentId, command_type, idempotencyKey); requested scopes that are not in the existing grant are silently ignored (no_op replay). Runs against ACTIVE and PAUSED installations because revoking scope on a paused installation is part of the security-review path. Unresolvable targets soft-fail with reason 'installation_not_found'. Risk class R2 per the H2 hardening plan because subtracting scope cannot expand authority.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--target ` | yes | Target. |
| `--scopes ` | yes | Scopes. |
| `--reason ` | no | Reason. |

**Example**

kf agent revoke-scope --tenant tnt_demo --actor-type USER --actor-id usr_sam --target  --scopes 

## kf agent suspend

Suspend an active agent installation, flipping its status to PAUSED and emitting agent.suspend.applied.

Suspend an active agent installation, flipping its status to PAUSED and emitting agent.suspend.applied. Idempotent on (tenantId, environmentId, command_type, idempotencyKey); an already-PAUSED row replays without re-emitting. REVOKED/EXPIRED rows soft-fail with reason 'terminal_status'; unresolvable targets soft-fail with reason 'installation_not_found' so a stale operator UI cannot break the receipt chain. Risk class R1 per the H2 hardening plan; policy enforcement on PAUSED installations is the runtime gate.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--target ` | yes | Target. |
| `--reason ` | yes | Reason. |

**Example**

kf agent suspend --tenant tnt_demo --actor-type USER --actor-id usr_sam --target  --reason

---

## kf alert

URL: https://www.karmanflow.com/developers/reference/cli/alert
Summary: Define alert rules, acknowledge triggers, and manage analytics alerts.

# kf alert

Define alert rules, acknowledge triggers, and manage analytics alerts.

## kf alert acknowledge-trigger

Mark an OPEN/ESCALATED trigger as ACKNOWLEDGED.

Mark an OPEN/ESCALATED trigger as ACKNOWLEDGED. Signals that someone is working it; does not resolve. Use ResolveAlertTrigger to close.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--trigger-id ` | yes | Trigger id. |
| `--note ` | no | Note. |

**Example**

kf alert acknowledge-trigger --tenant tnt_demo --actor-type USER --actor-id usr_sam --trigger-id 

## kf alert create-analytics

Create an analytics alert rule.

Create an analytics alert rule. Thin wrapper around UpsertAlertRule that validates scope vs metricSource agreement and enforces staff authority for scope=PLATFORM. TENANT rules run at R2 with analytics.alert:write; PLATFORM rules run at R3 with analytics.alert.platform:write.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--rule-key ` | yes | Rule key. |
| `--display-name ` | yes | Display name. |
| `--description ` | no | Description. |
| `--severity ` | yes | Severity. |
| `--spec ` | yes | Spec. |
| `--channels ` | no | Channels. |
| `--escalation-after-hours ` | no | Escalation after hours. |
| `--mute-until ` | no | Mute until. |
| `--scope ` | no | Scope. |

**Example**

kf alert create-analytics --tenant tnt_demo --actor-type USER --actor-id usr_sam --rule-key  --display-name  --severity  --spec 

## kf alert delete-analytics

Soft-delete an analytics alert rule by flipping status to DELETED.

Soft-delete an analytics alert rule by flipping status to DELETED. The row stays on alert_rules so triggers keep their FK target; the evaluator skip-filters DELETED rows.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--rule-key ` | yes | Rule key. |
| `--scope ` | yes | Scope. |
| `--expected-version ` | yes | Expected version. |

**Example**

kf alert delete-analytics --tenant tnt_demo --actor-type USER --actor-id usr_sam --rule-key  --scope  --expected-version 

## kf alert mute-analytics

Set or clear mute_until on an analytics alert rule.

Set or clear mute_until on an analytics alert rule. Muting holds the evaluator back from firing while leaving any open triggers in place; pass muteUntil=null to resume evaluation.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--rule-key ` | yes | Rule key. |
| `--scope ` | yes | Scope. |
| `--mute-until ` | yes | Mute until. |
| `--expected-version ` | yes | Expected version. |

**Example**

kf alert mute-analytics --tenant tnt_demo --actor-type USER --actor-id usr_sam --rule-key  --scope  --mute-until  --expected-version 

## kf alert resolve-trigger

Manually resolve a trigger with a resolution reason.

Manually resolve a trigger with a resolution reason. Emits alerts.trigger.resolved with cause=manual to distinguish from auto-resolve by EvaluateAlertRule when the metric returns to band.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--trigger-id ` | yes | Trigger id. |
| `--resolution-reason ` | yes | Resolution reason. |

**Example**

kf alert resolve-trigger --tenant tnt_demo --actor-type USER --actor-id usr_sam --trigger-id  --resolution-reason 

## kf alert update-analytics

CAS update of an existing analytics alert rule.

CAS update of an existing analytics alert rule. Re-validates scope vs metricSource agreement; refuses scope flips (delete then create instead). Underlying write goes through UpsertAlertRule so the outbox transaction is unchanged.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--rule-key ` | yes | Rule key. |
| `--display-name ` | yes | Display name. |
| `--description ` | no | Description. |
| `--severity ` | yes | Severity. |
| `--spec ` | yes | Spec. |
| `--channels ` | no | Channels. |
| `--escalation-after-hours ` | no | Escalation after hours. |
| `--mute-until ` | no | Mute until. |
| `--scope ` | yes | Scope. |
| `--status ` | no | Status. |
| `--expected-version ` | yes | Expected version. |

**Example**

kf alert update-analytics --tenant tnt_demo --actor-type USER --actor-id usr_sam --rule-key  --display-name  --severity  --spec  --scope  --expected-version 

## kf alert upsert-rule

Create or update a declarative alert rule (THRESHOLD, EVENT_PATTERN, or COUNT_WINDOW).

Create or update a declarative alert rule (THRESHOLD, EVENT_PATTERN, or COUNT_WINDOW). Rules drive pull-mode evaluations via EvaluateAlertRule and push-mode firing via MatchEventToAlertRules. Channels are logical names routed by downstream workers; no vendor is hardcoded.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--rule-key ` | yes | Rule key. |
| `--display-name ` | yes | Display name. |
| `--description ` | no | Description. |
| `--severity ` | yes | Severity. |
| `--spec ` | yes | Spec. |
| `--channels ` | no | Channels. |
| `--escalation-after-hours ` | no | Escalation after hours. |
| `--mute-until ` | no | Mute until. |
| `--scope ` | no | Scope. |
| `--created-by-actor-type ` | no | Created by actor type. |
| `--status ` | no | Status. |
| `--expected-version ` | yes | Expected version. |

**Example**

kf alert upsert-rule --tenant tnt_demo --actor-type USER --actor-id usr_sam --rule-key  --display-name  --severity  --spec  --expected-version

---

## kf auth

URL: https://www.karmanflow.com/developers/reference/cli/auth
Summary: Authentication helpers.

# kf auth

Inspect or end the local OAuth session for a profile. Login is at the top level (`kf login`).

## kf auth status

Print the resolved auth source for the active or selected profile.

Prints auth source (oauth, api-key-flag, api-key-env, api-key-profile, none), endpoint, tenant, environment, and OAuth metadata. Never prints token material.

| Flag | Required | Description |
| --- | --- | --- |
| `--profile ` | no | Inspect a profile other than the active one. |

**Example**

kf auth status --pretty

---

## kf bootstrap

URL: https://www.karmanflow.com/developers/reference/cli/bootstrap
Summary: Render and write Day-0 tenant bootstrap bundles.

# kf bootstrap

Day-0 onboarding helper that emits a sandbox-default bootstrap bundle. `template` prints the bundle to stdout; `init` writes it to disk.

## kf bootstrap template

Print the canonical Day-0 bootstrap bundle template.

Renders the default bundle for the chosen tenant + environment without touching the filesystem.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | no | Target tenant id. |
| `--account-name ` | no | Display name for the bundle account. |
| `--environment ` | no | Target environment id; defaults to sandbox. |

**Example**

kf bootstrap template --tenant tnt_demo --pretty

## kf bootstrap init

Write a local Day-0 bootstrap bundle with sandbox as the default environment.

Generates the bundle and writes every file into the chosen directory. Refuses to overwrite unless --force is passed.

| Flag | Required | Description |
| --- | --- | --- |
| `--dir ` | yes | Target directory for the bundle. |
| `--tenant ` | no | Target tenant id. |
| `--account-name ` | no | Display name for the bundle account. |
| `--environment ` | no | Target environment id; defaults to sandbox. |
| `--force` | no | Overwrite files that already exist. |

**Example**

kf bootstrap init --dir ./day0 --tenant tnt_demo

---

## kf commands

URL: https://www.karmanflow.com/developers/reference/cli/commands
Summary: Inspect the command registry.

# kf commands

Read-only view onto the canonical command registry. Useful for partner builders, support, and MCP tool generation.

## kf commands list

List registry-backed command metadata.

Returns every registered command type with aggregate, category, scopes, risk class, and emitted events.

**Example**

kf commands list --pretty

## kf commands show

Show one registry-backed command definition.

Show the full metadata for one command type.

**Example**

kf commands show CreateReservation --pretty

---

## kf connector

URL: https://www.karmanflow.com/developers/reference/cli/connector
Summary: Install, configure, rotate, and replay tenant connectors.

# kf connector

Install, configure, rotate, and replay tenant connectors.

## kf connector activate-as-shopify-fulfillment-service

Register Karman as a Shopify FulfillmentService against the bound shop.

Register Karman as a Shopify FulfillmentService against the bound shop. Sets connector_bindings.custom_fields.shopifyAsFulfillmentService=true and stores the partner-returned fulfillment_service_id and location_id so destinations can route shipment writes. Emits connector.fulfillment_service.activated. Risk class R3.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--shopify-fulfillment-service-id ` | yes | Shopify fulfillment service id. |
| `--shopify-location-id ` | yes | Shopify location id. |
| `--callback-url ` | yes | Callback url. |

**Example**

kf connector activate-as-shopify-fulfillment-service --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --shopify-fulfillment-service-id  --shopify-location-id  --callback-url 

## kf connector add-shopify-shop

Attach a secondary Shopify shop to an existing tenant binding (multi-shop).

Attach a secondary Shopify shop to an existing tenant binding (multi-shop). Requires an active primary Shopify binding for the tenant. Stores only a secret-store reference and emits connector.shop.added. Risk class R4 because the command accepts caller-managed connector credentials.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--shop-domain ` | yes | Shop domain. |
| `--access-token-secret-ref-stdin` | yes | Read Access token secret ref. from stdin. |
| `--scope ` | yes | Scope. |
| `--installed-by-actor-id ` | yes | Installed by actor id. |

**Example**

kf connector add-shopify-shop --tenant tnt_demo --actor-type USER --actor-id usr_sam --shop-domain  --access-token-secret-ref-stdin --scope  --installed-by-actor-id 

## kf connector deactivate-as-shopify-fulfillment-service

Deregister Karman as a Shopify FulfillmentService.

Deregister Karman as a Shopify FulfillmentService. Clears the binding's fulfillment-service custom fields. Emits connector.fulfillment_service.deactivated. Risk class R3.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |

**Example**

kf connector deactivate-as-shopify-fulfillment-service --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id 

## kf connector ignore-shopify-drift-event

Operator-driven dismiss for a Shopify drift inbox row.

Operator-driven dismiss for a Shopify drift inbox row. Emits connector.shopify.drift.ignored referencing the original drift event id; the drift inbox subtracts these from the recorded feed so dismissed rows drop off the operator view. Round 6 P1.6.3. Risk R2.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--drift-event-id ` | yes | Drift event id. |
| `--aggregate-type ` | yes | Aggregate type. |
| `--partner-aggregate-id ` | yes | Partner aggregate id. |
| `--dismissed-reason ` | no | Dismissed reason. |

**Example**

kf connector ignore-shopify-drift-event --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --drift-event-id  --aggregate-type  --partner-aggregate-id 

## kf connector install-shopify

Install (or reinstall) a Shopify connector binding after successful OAuth or custom-app credential entry.

Install (or reinstall) a Shopify connector binding after successful OAuth or custom-app credential entry. Stores only a secret-store reference, not the raw access token. Emits connector.shopify.installed on first install and connector.shopify.reinstalled on subsequent runs, and enqueues an INGEST_CONNECTOR_RUN job inside the same transaction. Risk class R4; grant connector.binding:write.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--shop-domain ` | yes | Shop domain. |
| `--access-token-secret-ref-stdin` | yes | Read Access token secret ref. from stdin. |
| `--scope ` | yes | Scope. |
| `--installed-by-actor-id ` | yes | Installed by actor id. |

**Example**

kf connector install-shopify --tenant tnt_demo --actor-type USER --actor-id usr_sam --shop-domain  --access-token-secret-ref-stdin --scope  --installed-by-actor-id 

## kf connector process-gdpr-data-request

Inbound Shopify customers/data_request route.

Inbound Shopify customers/data_request route. Records the request and emits gdpr.data_request.completed with an artifactRef pointing at the encrypted export bundle. Does not email the customer; that is the merchant's responsibility. Risk class R3; the webhook dispatcher files an approval request instead of executing without approval.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--provider ` | no | Provider. |
| `--partner-customer-id ` | yes | Partner customer id. |
| `--partner-customer-email ` | no | Partner customer email. |
| `--partner-orders-requested ` | no | Partner orders requested. |
| `--received-on ` | yes | ISO date/time |

**Example**

kf connector process-gdpr-data-request --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --partner-customer-id  --received-on 

## kf connector record-webhook-receipt

Record a generic inbound connector webhook receipt after signature verification and transition it to processed, deferred, ignored, or failed.

Record a generic inbound connector webhook receipt after signature verification and transition it to processed, deferred, ignored, or failed. Used by payment providers such as Adyen so webhook proof, replay, and command receipts are provider-neutral.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--connector-key ` | yes | Connector key. |
| `--provider ` | yes | Provider. |
| `--external-account-ref ` | no | External account ref. |
| `--delivery-id ` | yes | Delivery id. |
| `--topic ` | yes | Topic. |
| `--provider-event-id ` | no | Provider event id. |
| `--provider-reference ` | no | Provider reference. |
| `--body-hash ` | yes | Body hash. |
| `--replay-fingerprint ` | yes | Replay fingerprint. |
| `--hmac-verified ` | yes | Hmac verified. |
| `--raw-payload-ref ` | no | Raw payload ref. |
| `--received-on ` | no | ISO date/time |
| `--status ` | yes | Status. |
| `--last-error ` | no | Last error. |

**Example**

kf connector record-webhook-receipt --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --connector-key  --provider  --delivery-id  --topic  --body-hash  --replay-fingerprint  --hmac-verified  --status 

## kf connector redact-customer-data

Inbound Shopify customers/redact route.

Inbound Shopify customers/redact route. Tombstones the resolved Karman party (status=ERASED, name fields set to __redacted__) and marks every Party-scoped custom_field with field_group=REDACTED. Risk class R3; the webhook dispatcher files an approval request instead of executing without approval.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--provider ` | no | Provider. |
| `--partner-customer-id ` | yes | Partner customer id. |
| `--partner-customer-email ` | no | Partner customer email. |
| `--received-on ` | yes | ISO date/time |

**Example**

kf connector redact-customer-data --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --partner-customer-id  --received-on 

## kf connector redact-shop-data

Inbound Shopify shop/redact route.

Inbound Shopify shop/redact route. Mass-mutation that flips the binding to REVOKED, redacts every party scoped to the bound shop, and marks every Party/Address/ContactPoint custom field as REDACTED. Risk class R4: never auto-executed; requires explicit operator approval which is recorded as operatorApprovalReceiptId on the input.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--provider ` | no | Provider. |
| `--partner-shop-id ` | yes | Partner shop id. |
| `--shop-domain ` | yes | Shop domain. |
| `--received-on ` | yes | ISO date/time |
| `--operator-approval-receipt-id ` | yes | Operator approval receipt id. |

**Example**

kf connector redact-shop-data --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --partner-shop-id  --shop-domain  --received-on  --operator-approval-receipt-id 

## kf connector register-amazon-us-binding

Register (or reinstall) an Amazon US (SP-API) connector binding after a successful LWA handshake.

Register (or reinstall) an Amazon US (SP-API) connector binding after a successful LWA handshake. Stores only secret-store references (refresh token, LWA client id/secret, optional IAM keys and role ARN), never raw credentials. Activates the core.connector.amazon-us feature module in the same transaction so tenant discovery surfaces see Amazon as ACTIVE. Emits connector.amazon_us.installed on first install and connector.amazon_us.reinstalled on subsequent runs, and enqueues an INGEST_CONNECTOR_RUN job inside the same transaction. Risk class R4; grant connector.binding:write to operators and partner agents who onboard sellers.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--seller-id ` | yes | Seller id. |
| `--marketplace-ids ` | yes | Marketplace ids. |
| `--refresh-token-secret-ref-stdin` | yes | Read Refresh token secret ref. from stdin. |
| `--lwa-client-id-secret-ref-stdin` | yes | Read Lwa client id secret ref. from stdin. |
| `--lwa-client-secret-ref-stdin` | yes | Read Lwa client secret ref. from stdin. |
| `--iam-role-arn ` | no | Iam role arn. |
| `--iam-access-key-id-secret-ref-stdin` | no | Read Iam access key id secret ref. from stdin. |
| `--iam-secret-access-key-ref-stdin` | no | Read Iam secret access key ref. from stdin. |
| `--region ` | no | Region. |
| `--scope ` | yes | Scope. |
| `--installed-by-actor-id ` | yes | Installed by actor id. |

**Example**

kf connector register-amazon-us-binding --tenant tnt_demo --actor-type USER --actor-id usr_sam --seller-id  --marketplace-ids  --refresh-token-secret-ref-stdin --lwa-client-id-secret-ref-stdin --lwa-client-secret-ref-stdin --scope  --installed-by-actor-id 

## kf connector replay-sync

Operator-initiated replay of a connector ingestion run.

Operator-initiated replay of a connector ingestion run. Enqueues an INGEST_CONNECTOR_RUN job for the given binding, bypassing schedule cadence. Idempotent per metadata.idempotencyKey.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--run-type ` | yes | Run type. |
| `--entity-scope ` | no | Entity scope. |
| `--observed-from ` | no | ISO date/time |
| `--observed-to ` | no | ISO date/time |

**Example**

kf connector replay-sync --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --run-type 

## kf connector rotate-shopify-token

Replace the access-token secret reference on a Shopify connector binding.

Replace the access-token secret reference on a Shopify connector binding. Used by both the OAuth re-grant flow (public-app installs) and the operator paste-token flow (custom-app installs). Emits connector.token.rotated. Risk class R4 because the command accepts caller-managed connector credentials.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--access-token-secret-ref-stdin` | yes | Read Access token secret ref. from stdin. |
| `--scope ` | no | Scope. |
| `--rotated-by-actor-id ` | yes | Rotated by actor id. |

**Example**

kf connector rotate-shopify-token --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --access-token-secret-ref-stdin --rotated-by-actor-id 

## kf connector uninstall-shopify

Mark a Shopify connector binding REVOKED.

Mark a Shopify connector binding REVOKED. Single entry point for the inbound app/uninstalled webhook and operator-driven uninstall. Pauses jobs, invalidates secrets, and emits connector.binding_revoked. Idempotent on already-revoked bindings. Risk class R2.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--reason ` | yes | Reason. |
| `--detail ` | no | Detail. |

**Example**

kf connector uninstall-shopify --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --reason 

## kf connector upsert-transform-profile

Create or update a tenant TransformProfile in `tenant_configs.ingestion.transformProfiles`.

Create or update a tenant TransformProfile in `tenant_configs.ingestion.transformProfiles`. Single write path shared by the operator-console mapping UI and the mapping-author agent (unified-connector-interface invariant). Idempotent on metadata.idempotencyKey; bumps the catalog row's version on each commit. Approval-gated (R2 with requiresApproval) so agent-proposed mappings get human sign-off by default; a per-tenant policy may later auto-approve high-confidence proposals once trust is established.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--profile-id ` | yes | Profile id. |
| `--profile ` | yes | Profile. |
| `--proposed-by ` | yes | Proposed by. |
| `--rationale ` | no | Rationale. |

**Example**

kf connector upsert-transform-profile --tenant tnt_demo --actor-type USER --actor-id usr_sam --profile-id  --profile  --proposed-by

---

## kf control-center

URL: https://www.karmanflow.com/developers/reference/cli/control-center
Summary: Read the tenant Control Center cockpit snapshot.

# kf control-center

Read-only operator dashboard payload.

## kf control-center snapshot

Read the tenant Control Center cockpit snapshot through the GraphQL API.

Returns activity, attention, environments, deployments, app installations, broadcasts, recent events, and actions.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id. |
| `--limit ` | no | Section cap, default 25. |
| `--expiring-before ` | no | Filter expiring reservations before an ISO timestamp. |

**Example**

kf control-center snapshot --tenant tnt_demo --pretty

---

## kf events

URL: https://www.karmanflow.com/developers/reference/cli/events
Summary: Read recent domain events.

# kf events

Reads the tenant domain event stream over authenticated GraphQL. Read-only.

## kf events list

List recent tenant domain events over authenticated GraphQL.

Returns the most recent domain events for the tenant scope.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id. |
| `--limit ` | no | Result cap, default 20. |
| `--endpoint ` | no | GraphQL endpoint override. |
| `--api-key ` | no | API key argument (prefer --api-key-stdin). |
| `--api-key-stdin` | no | Read the API key from stdin. |

**Example**

kf events list --tenant tnt_demo --limit 50

---

## kf feature

URL: https://www.karmanflow.com/developers/reference/cli/feature
Summary: Install or disable feature modules and apps for the tenant.

# kf feature

Install or disable feature modules and apps for the tenant.

## kf feature disable-app

Pause a tenant environment app installation without revoking the install evidence, write an AppInstallation command receipt, emit app.installation.disabled, and pause the matching active FeatureModule activation when present so runtime execution stops while credentials and approvals remain auditable.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--installation-id ` | no | Installation id. |
| `--app-id ` | no | App id. |
| `--expected-version ` | yes | Expected version. |
| `--reason-code ` | yes | Reason code. |

**Example**

kf feature disable-app --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version  --reason-code 

## kf feature install-app

Install a partner App into a tenant environment by validating its manifest, namespace registration, approval receipt, and resolved FeatureModule surface, then writing the active app installation plus immutable app_installation_versions snapshot.

Install a partner App into a tenant environment by validating its manifest, namespace registration, approval receipt, and resolved FeatureModule surface, then writing the active app installation plus immutable app_installation_versions snapshot. Activation remains a separate FeatureActivationEngine step that re-checks the snapshot hash.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--manifest ` | yes | Manifest. |
| `--approved-scopes ` | no | Approved scopes. |
| `--approval-receipt-id ` | yes | Approval receipt id. |

**Example**

kf feature install-app --tenant tnt_demo --actor-type USER --actor-id usr_sam --manifest  --approval-receipt-id 

## kf feature revoke-app

Revoke a tenant environment app installation with expected-version protection, write an AppInstallation command receipt, emit app.installation.revoked, pause the matching active FeatureModule activation when present, and revoke app-linked connector bindings while clearing stored credential refs so the install gate fails closed on the next activation attempt.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--installation-id ` | no | Installation id. |
| `--app-id ` | no | App id. |
| `--expected-version ` | yes | Expected version. |
| `--reason-code ` | yes | Reason code. |

**Example**

kf feature revoke-app --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version  --reason-code

---

## kf feed

URL: https://www.karmanflow.com/developers/reference/cli/feed
Summary: Manage app feed deliveries and admin broadcasts.

# kf feed

Read, send, and update the lifecycle state of app feed items.

## kf feed list

List signed-in user app feed items through the GraphQL API.

Filters by status, category, web session, app installation, or limit.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id. |
| `--status ` | no | Filter by feed status. |
| `--category ` | no | Filter by feed category. |
| `--web-session-id ` | no | Filter by web session id. |
| `--app-installation-id ` | no | Filter by app installation id. |
| `--limit ` | no | Result cap. |

**Example**

kf feed list --tenant tnt_demo --status PENDING

## kf feed send

Send an admin-authored app feed item.

Also exposed to MCP as SendAdminBroadcast.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--title ` | yes | Feed item title. |
| `--body ` | yes | Feed item body. |
| `--actor-type ` | yes | Actor type. |
| `--actor-id ` | yes | Actor id. |
| `--severity ` | no | Severity level. |
| `--category ` | no | Feed category key. |
| `--badge-label ` | no | Optional badge label. |
| `--badge-tone ` | no | Optional badge tone. |
| `--action-label ` | no | Optional action label. |
| `--action-url ` | no | Optional action URL. |
| `--target-scope ` | no | Delivery scope. |

**Example**

kf feed send --tenant tnt_demo --title 'Maintenance' --body 'Brief downtime tonight.' --actor-type USER --actor-id usr_sam

## kf feed delivered

Mark one app feed delivery as delivered.

Idempotent via --idempotency-key.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--delivery-id ` | yes | Feed delivery id. |
| `--expected-version ` | yes | Optimistic concurrency token. |
| `--actor-type ` | yes | Actor type. |
| `--actor-id ` | yes | Actor id. |
| `--web-session-id ` | no | Originating web session id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. |

**Example**

kf feed delivered --tenant tnt_demo --delivery-id dlv_01 --expected-version 1 --actor-type USER --actor-id usr_sam

## kf feed acknowledge

Acknowledge one app feed delivery.

Idempotent via --idempotency-key.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--delivery-id ` | yes | Feed delivery id. |
| `--expected-version ` | yes | Optimistic concurrency token. |
| `--actor-type ` | yes | Actor type. |
| `--actor-id ` | yes | Actor id. |
| `--web-session-id ` | no | Originating web session id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. |

**Example**

kf feed acknowledge --tenant tnt_demo --delivery-id dlv_01 --expected-version 2 --actor-type USER --actor-id usr_sam

## kf feed dismiss

Dismiss one app feed delivery.

Idempotent via --idempotency-key.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--delivery-id ` | yes | Feed delivery id. |
| `--expected-version ` | yes | Optimistic concurrency token. |
| `--actor-type ` | yes | Actor type. |
| `--actor-id ` | yes | Actor id. |
| `--web-session-id ` | no | Originating web session id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. |

**Example**

kf feed dismiss --tenant tnt_demo --delivery-id dlv_01 --expected-version 2 --actor-type USER --actor-id usr_sam

---

## kf file-drop

URL: https://www.karmanflow.com/developers/reference/cli/file-drop
Summary: Register and operate file-drop bindings for batch ingestion.

# kf file-drop

Register and operate file-drop bindings for batch ingestion.

## kf file-drop pause-binding

Pause a binding so new transfers are rejected at the ingest surface.

Pause a binding so new transfers are rejected at the ingest surface. PAUSED -> ACTIVE is handled by ResumeFileDropBinding.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--expected-version ` | yes | Expected version. |
| `--reason ` | no | Reason. |

**Example**

kf file-drop pause-binding --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --expected-version 

## kf file-drop register-binding

Register an inbound or outbound file-drop binding.

Register an inbound or outbound file-drop binding. INBOUND KF-hosted bindings are R2; OUTBOUND bindings are R3; TENANT_* and partner-owned bindings are R4 because the platform accepts caller-managed credentials or delegated external authority. Approval-gated: the approval is bound to commandType=RegisterFileDropBinding and resourceId=<identifier> within the tenant environment, with a 24h TTL. Starts at PENDING; activates on first successful transfer. Disposition A per the internal implementation notes.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--identifier ` | yes | Identifier. |
| `--direction ` | yes | Direction. |
| `--location ` | yes | Location. |
| `--credentials-secret-ref-stdin` | no | Read Credentials secret ref. from stdin. |
| `--parser-profile-id ` | no | Parser profile id. |
| `--target-command-type ` | no | Target command type. |
| `--idempotency-scope ` | yes | Idempotency scope. |
| `--rate-limit ` | yes | Rate limit. |
| `--owner-lane ` | yes | Owner lane. |

**Example**

kf file-drop register-binding --tenant tnt_demo --actor-type USER --actor-id usr_sam --identifier  --direction  --location  --idempotency-scope  --rate-limit  --owner-lane 

## kf file-drop replay-transfer

Re-parse a prior transfer under a fresh correlation id.

Re-parse a prior transfer under a fresh correlation id. Creates a new file_drop_transfers row linked via custom_fields.replayed_from; the original row is preserved. Approval-gated (R3) because a replay can re-emit downstream commands.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--transfer-id ` | yes | Transfer id. |

**Example**

kf file-drop replay-transfer --tenant tnt_demo --actor-type USER --actor-id usr_sam --transfer-id 

## kf file-drop resume-binding

Resume a paused binding.

Resume a paused binding. No transfers are replayed on resume; callers drop new files through the standard ingest path.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--expected-version ` | yes | Expected version. |
| `--reason ` | no | Reason. |

**Example**

kf file-drop resume-binding --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --expected-version 

## kf file-drop revoke-binding

Terminal revoke of a binding.

Terminal revoke of a binding. Once REVOKED the binding cannot be updated, resumed, or used; a new registration is required. Approval-gated (R4) because the state is irreversible.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--expected-version ` | yes | Expected version. |
| `--reason ` | yes | Reason. |

**Example**

kf file-drop revoke-binding --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --expected-version  --reason 

## kf file-drop rotate-credential

Point a binding at a new credentials_secret_ref.

Point a binding at a new credentials_secret_ref. The receipt and event deliberately omit the ref value so audit trails never expose secret material. Approval-gated (R3).

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--expected-version ` | yes | Expected version. |
| `--new-credentials-secret-ref-stdin` | yes | Read New credentials secret ref. from stdin. |

**Example**

kf file-drop rotate-credential --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --expected-version  --new-credentials-secret-ref-stdin

## kf file-drop update-binding

Update rate limit, parser profile, or target command type on a binding.

Update rate limit, parser profile, or target command type on a binding. Direction, transport, and identifier are immutable and rejected at validation. Version-CAS on file_drop_bindings.version.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--binding-id ` | yes | Binding id. |
| `--expected-version ` | yes | Expected version. |
| `--rate-limit ` | no | Rate limit. |
| `--parser-profile-id ` | no | Parser profile id. |
| `--target-command-type ` | no | Target command type. |
| `--direction ` | no | not accepted for this command |
| `--transport ` | no | not accepted for this command |
| `--identifier ` | no | not accepted for this command |

**Example**

kf file-drop update-binding --tenant tnt_demo --actor-type USER --actor-id usr_sam --binding-id  --expected-version

---

## kf fulfillment

URL: https://www.karmanflow.com/developers/reference/cli/fulfillment
Summary: Manage fulfillment orders.

# kf fulfillment

Idempotent FulfillmentOrder lifecycle commands.

## kf fulfillment order create

Create a FulfillmentOrder from an Order at status=CREATED.

Idempotent via --idempotency-key.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--order-id ` | yes | Source order id. |
| `--actor-type ` | yes | Actor type. |
| `--actor-id ` | yes | Actor id. |
| `--fulfillment-ref ` | no | Tenant-supplied fulfillment reference. |
| `--source-location ` | no | Picking location id. |
| `--ship-to-party ` | no | Ship-to party id. |
| `--ship-to-address ` | no | Ship-to address id. |
| `--priority ` | no | Numeric priority. |
| `--planned-dispatch ` | no | Planned dispatch ISO timestamp. |
| `--source-system ` | no | Source system name for audit. |
| `--idempotency-key ` | no | Idempotency key for safe retries. |

**Example**

kf fulfillment order create --tenant tnt_demo --order-id ord_01 --actor-type USER --actor-id usr_sam

## kf fulfillment order allocate

Transition a FulfillmentOrder from CREATED to ALLOCATED.

Idempotent via --idempotency-key.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--fulfillment-order-id ` | yes | Fulfillment order id. |
| `--expected-version ` | yes | Optimistic concurrency token. |
| `--actor-type ` | yes | Actor type. |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. |

**Example**

kf fulfillment order allocate --tenant tnt_demo --fulfillment-order-id ful_01 --expected-version 1 --actor-type USER --actor-id usr_sam

---

## kf identity

URL: https://www.karmanflow.com/developers/reference/cli/identity
Summary: Create parties, addresses, and contact points for the tenant.

# kf identity

Create parties, addresses, and contact points for the tenant.

## kf identity assign-party-role

Assign a role such as CUSTOMER, SUPPLIER, CARRIER, or BUYER_CONTACT to a Party within a tenant, channel, location, order, or app scope.

Assign a role such as CUSTOMER, SUPPLIER, CARRIER, or BUYER_CONTACT to a Party within a tenant, channel, location, order, or app scope. Emits identity.party_role.assigned with ids and role facts only.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--party-id ` | yes | Party id. |
| `--role-type ` | yes | Role type. |
| `--scope-type ` | yes | Scope type. |
| `--scope-id ` | no | Scope id. |
| `--valid-from ` | no | ISO date/time |
| `--valid-to ` | no | ISO date/time |

**Example**

kf identity assign-party-role --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-id  --role-type  --scope-type 

## kf identity create-address

Insert one addresses row at status=ACTIVE attached to a parent Party.

Insert one addresses row at status=ACTIVE attached to a parent Party. Address values stay on the row; identity.address.created references address + party by id only.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--party-id ` | yes | Party id. |
| `--kind ` | yes | Kind. |
| `--line1 ` | yes | Line1. |
| `--line2 ` | no | Line2. |
| `--line3 ` | no | Line3. |
| `--city ` | no | City. |
| `--region ` | no | Region. |
| `--region-code ` | no | Region code. |
| `--postal-code ` | no | Postal code. |
| `--country-code ` | yes | Country code. |

**Example**

kf identity create-address --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-id  --kind  --line1  --country-code 

## kf identity create-contact-point

Insert one contact_points row at status=ACTIVE attached to a parent Party.

Insert one contact_points row at status=ACTIVE attached to a parent Party. The raw value (email, phone, webhook URL) stays on the row; identity.contact_point.created carries party + contact-point ids only.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--party-id ` | yes | Party id. |
| `--contact-type ` | yes | Contact type. |
| `--value ` | yes | Value. |
| `--value-normalized ` | no | Value normalized. |
| `--preferred ` | no | Preferred. |
| `--preferred-language ` | no | Preferred language. |
| `--preferred-locale ` | no | Preferred locale. |

**Example**

kf identity create-contact-point --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-id  --contact-type  --value 

## kf identity create-party

Insert one parties row at status=ACTIVE.

Insert one parties row at status=ACTIVE. PII (legal_name, given_name, family_name) lives only on the row; the emitted identity.party.created event references the party by id only.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--party-type ` | yes | Party type. |
| `--legal-name ` | no | Legal name. |
| `--display-name ` | no | Display name. |
| `--given-name ` | no | Given name. |
| `--family-name ` | no | Family name. |
| `--external-ref ` | no | External ref. |

**Example**

kf identity create-party --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-type 

## kf identity erase-party

GDPR-style erasure of a Party plus all child Addresses and ContactPoints.

GDPR-style erasure of a Party plus all child Addresses and ContactPoints. Pseudonymizes PII columns in place to preserve referential integrity for orders and fulfillments. Requires an APPROVED approval_request scoped to (Party, partyId, EraseParty). Risk class R4, irreversible.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--party-id ` | yes | Party id. |
| `--approval-request-id ` | yes | Approval request id. |
| `--reason ` | no | Reason. |

**Example**

kf identity erase-party --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-id  --approval-request-id

---

## kf incident

URL: https://www.karmanflow.com/developers/reference/cli/incident
Summary: Open, triage, escalate, acknowledge, and resolve incidents.

# kf incident

Open, triage, escalate, acknowledge, and resolve incidents.

## kf incident acknowledge

Mark a firing or triaging Incident as acknowledged_no_op.

Mark a firing or triaging Incident as acknowledged_no_op. Used when the Signal is informational, the operator has read it, and no autofix or escalation is appropriate.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--incident-id ` | yes | Incident id. |
| `--expected-version ` | yes | Expected version. |
| `--acknowledged-by ` | yes | Acknowledged by. |
| `--reason ` | yes | Reason. |

**Example**

kf incident acknowledge --tenant tnt_demo --actor-type USER --actor-id usr_sam --incident-id  --expected-version  --acknowledged-by  --reason 

## kf incident escalate

Escalate an Incident to a human owner from firing, triaging, or proposed.

Escalate an Incident to a human owner from firing, triaging, or proposed. Records the reason and stamps escalated_on; the autofix loop stops here until an operator resolves or acknowledges.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--incident-id ` | yes | Incident id. |
| `--expected-version ` | yes | Expected version. |
| `--reason ` | yes | Reason. |

**Example**

kf incident escalate --tenant tnt_demo --actor-type USER --actor-id usr_sam --incident-id  --expected-version  --reason 

## kf incident execute-action

Execute the ProposedAction for an Incident in proposed.

Execute the ProposedAction for an Incident in proposed. Records resolved_command_receipt_id, transitions through executing to resolved atomically, and emits both incidents.action_executed and incidents.resolved in the same transaction. DENY proposals cannot execute; R3 and R4 proposals require a bound APPROVED approval request.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--incident-id ` | yes | Incident id. |
| `--expected-version ` | yes | Expected version. |
| `--resolved-command-receipt-id ` | yes | Resolved command receipt id. |

**Example**

kf incident execute-action --tenant tnt_demo --actor-type USER --actor-id usr_sam --incident-id  --expected-version  --resolved-command-receipt-id 

## kf incident open

Open an Incident, or join an existing open one when the (tenantId, environmentId, fingerprint) tuple already has a row not in resolved or acknowledged_no_op.

Open an Incident, or join an existing open one when the (tenantId, environmentId, fingerprint) tuple already has a row not in resolved or acknowledged_no_op. Idempotent on metadata.idempotencyKey. Back-fills signals.incident_id when a new Signal joins an existing Incident. Drives the Signal Plane state machine; see implementation notes

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--signal-id ` | yes | Signal id. |
| `--fingerprint ` | yes | Fingerprint. |
| `--severity ` | yes | Severity. |
| `--fault-class ` | yes | Fault class. |
| `--surface ` | yes | Surface. |
| `--code ` | yes | Code. |
| `--attributes ` | no | Attributes. |
| `--opened-on ` | yes | Opened on. |

**Example**

kf incident open --tenant tnt_demo --actor-type USER --actor-id usr_sam --signal-id  --fingerprint  --severity  --fault-class  --surface  --code  --opened-on 

## kf incident propose-action

Attach a ProposedAction to an Incident in triaging.

Attach a ProposedAction to an Incident in triaging. Stores the canonical ProposedAction shape from implementation source: commandType, input, dryRunPreview, riskClass (R0..R4), policyDecision (ALLOW | REQUIRES_APPROVAL | DENY), rationale, modelId, evalScore. Transitions to proposed.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--incident-id ` | yes | Incident id. |
| `--expected-version ` | yes | Expected version. |
| `--proposed-action-id ` | yes | Proposed action id. |
| `--command-type ` | yes | Command type. |
| `--input ` | yes | Input. |
| `--dry-run-preview ` | yes | Dry run preview. |
| `--risk-class ` | yes | Risk class. |
| `--policy-decision ` | yes | Policy decision. |
| `--rationale ` | yes | Rationale. |
| `--model-id ` | yes | Model id. |
| `--eval-score ` | yes | Eval score. |

**Example**

kf incident propose-action --tenant tnt_demo --actor-type USER --actor-id usr_sam --incident-id  --expected-version  --proposed-action-id  --command-type  --input  --dry-run-preview  --risk-class  --policy-decision  --rationale  --model-id  --eval-score 

## kf incident resolve

Resolve an Incident from any non-terminal state with a free-form reason.

Resolve an Incident from any non-terminal state with a free-form reason. Used for manual close-outs and for the auto-resolve path when the underlying Signal has stopped firing for a sustained window.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--incident-id ` | yes | Incident id. |
| `--expected-version ` | yes | Expected version. |
| `--reason ` | yes | Reason. |

**Example**

kf incident resolve --tenant tnt_demo --actor-type USER --actor-id usr_sam --incident-id  --expected-version  --reason 

## kf incident triage

Transition an Incident from firing to triaging and assign a triage skill name.

Transition an Incident from firing to triaging and assign a triage skill name. Version-checked; raises VersionConflictError on stale expectedVersion and InvalidStateError if the Incident is not in firing.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--incident-id ` | yes | Incident id. |
| `--expected-version ` | yes | Expected version. |
| `--assigned-skill ` | yes | Assigned skill. |

**Example**

kf incident triage --tenant tnt_demo --actor-type USER --actor-id usr_sam --incident-id  --expected-version  --assigned-skill

---

## kf ingestion

URL: https://www.karmanflow.com/developers/reference/cli/ingestion
Summary: Open, submit, and commit ingestion runs and source authorities.

# kf ingestion

Open, submit, and commit ingestion runs and source authorities.

## kf ingestion commit-batch

Apply a staged ingestion batch to inventory truth.

Apply a staged ingestion batch to inventory truth. Writes inventory_levels, movements, and channel_availabilities inside one transaction.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--ingestion-run-id ` | yes | Ingestion run id. |
| `--ingestion-batch-id ` | yes | Ingestion batch id. |

**Example**

kf ingestion commit-batch --tenant tnt_demo --actor-type USER --actor-id usr_sam --ingestion-run-id  --ingestion-batch-id 

## kf ingestion start-run

Open an ingestion run so a connector can stream batches against it.

Open an ingestion run so a connector can stream batches against it. Used for snapshot, delta, event, and replay imports from external systems.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--connector-key ` | yes | Connector key. |
| `--source-system ` | yes | Source system. |
| `--run-type ` | yes | Run type. |
| `--observed-from ` | no | ISO date/time |
| `--observed-to ` | no | ISO date/time |
| `--checkpoint-ref ` | no | Checkpoint ref. |
| `--raw-payload-ref ` | no | Raw payload ref. |
| `--summary ` | no | Summary. |

**Example**

kf ingestion start-run --tenant tnt_demo --actor-type USER --actor-id usr_sam --connector-key  --source-system  --run-type 

## kf ingestion submit-batch

Submit a normalized batch of records to a running ingestion run.

Submit a normalized batch of records to a running ingestion run. Records are staged for commit; no inventory state is mutated yet.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--ingestion-run-id ` | yes | Ingestion run id. |
| `--batch-ref ` | no | Batch ref. |
| `--classification ` | yes | Classification. |
| `--records ` | yes | Records. |
| `--summary ` | no | Summary. |

**Example**

kf ingestion submit-batch --tenant tnt_demo --actor-type USER --actor-id usr_sam --ingestion-run-id  --classification  --records

---

## kf inventory

URL: https://www.karmanflow.com/developers/reference/cli/inventory
Summary: Inspect and adjust inventory.

# kf inventory

Read-only inventory levels plus the canonical adjust + transfer create commands.

## kf inventory levels

List inventory levels via authenticated GraphQL.

Filters by variant or location. Read-only.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id. |
| `--variant ` | no | Filter by variant id. |
| `--location ` | no | Filter by location id. |
| `--limit ` | no | Result cap, default 20. |

**Example**

kf inventory levels --tenant tnt_demo --location loc_edison

## kf inventory contracts

List canonical inventory IO public contracts.

Local read-only manifest view of InventorySource, InventorySignal, InventoryHistory, and InventoryExport contracts with schema refs, MCP discovery tool, and reverse-domain extension namespace rules.

| Flag | Required | Description |
| --- | --- | --- |
| `--contract ` | no | Filter to one inventory IO contract. |

**Example**

kf inventory contracts --contract InventorySignal --pretty

## kf inventory adjust

Adjust on_hand, reserved, or allocated quantity on an inventory level.

Idempotent via --idempotency-key. Adjusts a single bucket with optimistic concurrency via --expected-version.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--inventory-level-id ` | yes | Target inventory level id. |
| `--quantity-type ` | yes | Bucket to adjust. |
| `--delta ` | yes | Signed delta to apply. |
| `--expected-version ` | yes | Optimistic concurrency token. |
| `--actor-type ` | yes | Actor type (USER, AGENT, API_KEY, SYSTEM). |
| `--actor-id ` | yes | Actor id. |
| `--reason ` | no | Domain reason code. |
| `--idempotency-key ` | no | Idempotency key for safe retries. |

**Example**

kf inventory adjust --tenant tnt_demo --inventory-level-id il_01 --quantity-type ON_HAND --delta -1 --expected-version 4 --actor-type USER --actor-id usr_sam

## kf inventory transfer create

Kick off a stock transfer between two locations.

Decreases available at the source by moving quantity into in-transit. Idempotent via --idempotency-key.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--transfer-ref ` | yes | Tenant-supplied transfer reference. |
| `--variant ` | yes | Variant id. |
| `--from-location ` | yes | Source location id. |
| `--to-location ` | yes | Destination location id. |
| `--owner-id ` | yes | Inventory owner id. |
| `--from-level-id ` | yes | Source inventory level id. |
| `--to-level-id ` | yes | Destination inventory level id. |
| `--quantity ` | yes | Quantity to move. |
| `--actor-type ` | yes | Actor type. |
| `--actor-id ` | yes | Actor id. |
| `--reason ` | no | Domain reason code. |
| `--ship-by ` | no | Ship-by ISO timestamp. |
| `--expected-delivery ` | no | Expected delivery ISO timestamp. |
| `--carrier ` | no | Carrier name. |
| `--tracking-ref ` | no | Carrier tracking reference. |
| `--idempotency-key ` | no | Idempotency key for safe retries. |

**Example**

kf inventory transfer create --tenant tnt_demo --transfer-ref T-1 --variant v_01 --from-location loc_a --to-location loc_b --owner-id own_01 --from-level-id il_a --to-level-id il_b --quantity 5 --actor-type USER --actor-id usr_sam

---

## kf issues

URL: https://www.karmanflow.com/developers/reference/cli/issues
Summary: Read and acknowledge readable Issues from the local file Issue store.

# kf issues

Issues capture human-and-agent-readable signals. Local file store today; durable surface lands in Phase 3b.

## kf issues list

List Issues from the local file Issue store after applying the Issue access gate.

Defaults to platform-admin local access. Filters narrow scope, severity, state, autofix skill, tenant, and partner.

| Flag | Required | Description |
| --- | --- | --- |
| `--scope ` | no | Filter by Issue scope. |
| `--severity ` | no | Filter by severity. |
| `--state ` | no | Filter by state. |
| `--autofix-skill ` | no | Filter by autofix skill. |
| `--limit ` | no | Result cap. |
| `--dir ` | no | Override Issue store directory. |
| `--tenant ` | no | Filter by tenant id. |
| `--environment ` | no | Filter by environment id. |
| `--partner-id ` | no | Filter by partner id. |
| `--actor ` | no | Caller actor name for the access gate. |
| `--actor-type ` | no | Caller actor type. |
| `--issue-scope ` | no | Override the access-gate Issue scope. |

**Example**

kf issues list --severity HIGH --state OPEN

## kf issues show

Show one readable Issue from the local file Issue store.

Includes evidence and state history.

| Flag | Required | Description |
| --- | --- | --- |
| `--dir ` | no | Override Issue store directory. |
| `--tenant ` | no | Tenant id for the access gate. |
| `--environment ` | no | Environment id for the access gate. |
| `--partner-id ` | no | Partner id for the access gate. |
| `--actor ` | no | Caller actor name. |
| `--actor-type ` | no | Caller actor type. |
| `--issue-scope ` | no | Access-gate Issue scope override. |

**Example**

kf issues show iss_01HZ7GCK6QF4P7M3T8ZX9V2DQE

## kf issues close

Acknowledge a readable Issue when the caller has issue:close or platform-admin.

Reason is required. Local file Issue store only.

| Flag | Required | Description |
| --- | --- | --- |
| `--reason ` | yes | Closure reason. |
| `--dir ` | no | Override Issue store directory. |
| `--actor ` | no | Caller actor name. |
| `--actor-type ` | no | Caller actor type. |
| `--tenant ` | no | Tenant id for the access gate. |
| `--environment ` | no | Environment id for the access gate. |
| `--partner-id ` | no | Partner id for the access gate. |
| `--issue-scope ` | no | Access-gate Issue scope override. |

**Example**

kf issues close iss_01 --reason 'mitigated by stock transfer'

---

## kf login

URL: https://www.karmanflow.com/developers/reference/cli/login
Summary: Save GraphQL endpoint and credentials to the active profile.

# kf login

Stores endpoint, tenant, environment, and a redacted API key preview in the active profile. With --oauth, runs the device authorization flow and writes credentials.json (mode 0600).

## kf login

Save GraphQL endpoint, tenant, environment, and a redacted API key preview to the active profile.

Use --api-key-stdin to avoid placing the API key on the argv. Use --oauth to run the device authorization flow instead of API-key transport.

| Flag | Required | Description |
| --- | --- | --- |
| `--endpoint ` | yes | GraphQL endpoint URL. |
| `--api-key ` | no | API key argument (prefer --api-key-stdin). |
| `--api-key-stdin` | no | Read the API key from stdin. |
| `--tenant ` | no | Default tenant for this profile. |
| `--environment ` | no | Default environment for this profile. |
| `--oauth` | no | Use device-authorization OAuth instead of API-key transport. |

**Example**

kf login --endpoint https://api.karmanflow.test/graphql --tenant tnt_demo --api-key-stdin

---

## kf logout

URL: https://www.karmanflow.com/developers/reference/cli/logout
Summary: Clear the OAuth credentials and OAuth profile previews.

# kf logout

Clears the OAuth credentials file and OAuth profile previews for one profile. The profile itself stays usable for API-key transport.

## kf logout

Clear the OAuth credentials and OAuth profile previews for one profile.

No mutation if the profile has no OAuth credentials. Idempotent.

| Flag | Required | Description |
| --- | --- | --- |
| `--profile ` | no | Profile to clear; defaults to the active profile. |

**Example**

kf logout --profile staging

---

## kf onboarding

URL: https://www.karmanflow.com/developers/reference/cli/onboarding
Summary: Drive the persona-led onboarding flow and aha moments.

# kf onboarding

Drive the persona-led onboarding flow and aha moments.

## kf onboarding advance-step

Advance the onboarding state machine from a named current step to a named next step.

Advance the onboarding state machine from a named current step to a named next step. Rejects with ONBOARDING_STEP_MISMATCH if the caller's stepId does not match the row's current_step; idempotent replay when the step is already landed. Emits onboarding.completed when nextStepId=='done'.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--expected-version ` | yes | Expected version. |
| `--step-id ` | yes | Step id. |
| `--next-step-id ` | yes | Next step id. |

**Example**

kf onboarding advance-step --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version  --step-id  --next-step-id 

## kf onboarding fire-aha-moment-scenario

Run a deterministic aha-moment scenario against the tenant's seeded sample inventory.

Run a deterministic aha-moment scenario against the tenant's seeded sample inventory. Dispatches three reservations across channels under a shared correlation id so operators see the ATP drop, policy DENY paths, and command/event chain in real time. Composite orchestration: uses existing reservation commands through the shared command envelope and records an onboarding.aha_scenario_completed event on success.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--expected-version ` | yes | Expected version. |
| `--scenario-id ` | no | Scenario id. |

**Example**

kf onboarding fire-aha-moment-scenario --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version 

## kf onboarding record-aha-moment

Stamp the first-aha moment (oversell prevented, first agent task approved, first reservation committed).

Stamp the first-aha moment (oversell prevented, first agent task approved, first reservation committed). Only the first firing sets aha_fired_at; subsequent scenarios append to metadata.aha_scenarios so time-to-first-value stays stable across a tenant's lifecycle.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--expected-version ` | yes | Expected version. |
| `--scenario-id ` | yes | Scenario id. |
| `--evidence-correlation-id ` | yes | Evidence correlation id. |

**Example**

kf onboarding record-aha-moment --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version  --scenario-id  --evidence-correlation-id 

## kf onboarding reset

Reset the progress row back to 'signup' while preserving started_at and appending to metadata.reset_history.

Reset the progress row back to 'signup' while preserving started_at and appending to metadata.reset_history. Risk class R3; intended for controlled preview support flows, not day-to-day tenant operations. Every reset emits an audit event.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--expected-version ` | yes | Expected version. |
| `--reason ` | yes | Reason. |

**Example**

kf onboarding reset --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version  --reason 

## kf onboarding set-persona

Record the persona a tenant selects during onboarding.

Record the persona a tenant selects during onboarding. Advances current_step from 'signup' to 'persona' on first selection; subsequent calls update persona in place without re-advancing. Persona drives ConfigureTenantDefaults and downstream playbook selection.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--expected-version ` | yes | Expected version. |
| `--persona ` | yes | Persona. |

**Example**

kf onboarding set-persona --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version  --persona 

## kf onboarding skip-step

Skip the current onboarding step with a required reason, then advance to nextStepId.

Skip the current onboarding step with a required reason, then advance to nextStepId. The skipped step lands on completed_steps with skipped=true and is also denormalized onto skipped_steps for fast funnel queries.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--expected-version ` | yes | Expected version. |
| `--step-id ` | yes | Step id. |
| `--next-step-id ` | yes | Next step id. |
| `--reason ` | yes | Reason. |

**Example**

kf onboarding skip-step --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version  --step-id  --next-step-id  --reason 

## kf onboarding start

Open the onboarding progress state machine for one (tenant, environment).

Open the onboarding progress state machine for one (tenant, environment). Idempotent; if a row already exists the command returns it with alreadyExisted=true and emits no duplicate onboarding.started event. Current step lands at 'signup' because bootstrapTenant auto-completes signup upstream.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--source ` | no | Source. |
| `--progress-metadata ` | no | Progress metadata. |

**Example**

kf onboarding start --tenant tnt_demo --actor-type USER --actor-id usr_sam

---

## kf profile

URL: https://www.karmanflow.com/developers/reference/cli/profile
Summary: Manage local CLI profiles.

# kf profile

Profiles are local-only. Their values bind endpoint, tenant, environment, and OAuth metadata.

## kf profile list

List local CLI profiles without printing raw API keys.

Returns the profile name, endpoint, defaults, and OAuth metadata.

**Example**

kf profile list --pretty

## kf profile show

Show one local CLI profile with only the redacted API key preview.

Shows defaults and OAuth metadata for a single profile.

| Flag | Required | Description |
| --- | --- | --- |
| `--profile ` | no | Profile to show; defaults to the active profile. |

**Example**

kf profile show --profile staging

## kf profile use

Set the active local CLI profile.

Marks the named profile as active in the local config file.

**Example**

kf profile use staging

## kf profile clear

Delete one local CLI profile.

Removes the named profile and its credentials.

**Example**

kf profile clear staging

---

## kf receipts

URL: https://www.karmanflow.com/developers/reference/cli/receipts
Summary: Read command receipts.

# kf receipts

Reads the command receipt store over authenticated GraphQL. Read-only.

## kf receipts list

List recent command receipts over authenticated GraphQL.

Lists receipts filtered by command type, actor, or status.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id. |
| `--limit ` | no | Result cap, default 20. |
| `--command-type ` | no | Filter by command type. |
| `--status ` | no | Filter by receipt status. |
| `--actor-id ` | no | Filter by actor id. |

**Example**

kf receipts list --tenant tnt_demo --status SUCCEEDED

## kf receipts show

Show one command receipt over authenticated GraphQL.

Reads one receipt by command id.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id. |

**Example**

kf receipts show cmd_01HZ7GCK6MN1Q9V8P3T7B5XJ4F --tenant tnt_demo

---

## kf reservation

URL: https://www.karmanflow.com/developers/reference/cli/reservation
Summary: Manage reservations on the inventory hot path.

# kf reservation

Idempotent reservation lifecycle commands. Replays return the original receipt; explicit expire is for manual cleanup.

## kf reservation commit

Commit a reservation through the GraphQL command surface.

Idempotent via --idempotency-key.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--reservation-id ` | yes | Reservation id. |
| `--expected-version ` | yes | Optimistic concurrency token. |
| `--actor-type ` | yes | Actor type. |
| `--actor-id ` | yes | Actor id. |
| `--reason ` | no | Domain reason code. |
| `--idempotency-key ` | no | Idempotency key for safe retries. |

**Example**

kf reservation commit --tenant tnt_demo --reservation-id rsv_01 --expected-version 1 --actor-type USER --actor-id usr_sam

## kf reservation expire

Force-expire an ACTIVE reservation past its expiresOn.

Normally driven by the expire-sweeper worker; exposed for explicit cleanup workflows.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--reservation-id ` | yes | Reservation id. |
| `--expected-version ` | yes | Optimistic concurrency token. |
| `--actor-type ` | yes | Actor type. |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. |

**Example**

kf reservation expire --tenant tnt_demo --reservation-id rsv_01 --expected-version 3 --actor-type USER --actor-id usr_sam

---

## kf schedule

URL: https://www.karmanflow.com/developers/reference/cli/schedule
Summary: Create, pause, resume, and cancel tenant job schedules.

# kf schedule

Create, pause, resume, and cancel tenant job schedules.

## kf schedule cancel-job

Cancel a recurring schedule by moving it to DISABLED.

Cancel a recurring schedule by moving it to DISABLED. This is a reversible audit record, not a hard delete.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--schedule-id ` | yes | Schedule id. |
| `--reason ` | no | Reason. |

**Example**

kf schedule cancel-job --tenant tnt_demo --actor-type USER --actor-id usr_sam --schedule-id 

## kf schedule pause-job

Pause a recurring schedule without deleting it.

Pause a recurring schedule without deleting it. Existing jobs remain auditable; no new planned runs are materialized while paused.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--schedule-id ` | yes | Schedule id. |
| `--reason ` | no | Reason. |

**Example**

kf schedule pause-job --tenant tnt_demo --actor-type USER --actor-id usr_sam --schedule-id 

## kf schedule resume-job

Resume a paused or errored schedule.

Resume a paused or errored schedule. Optionally provide nextRunOn to control the first resumed planned run.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--schedule-id ` | yes | Schedule id. |
| `--next-run-on ` | no | ISO date/time |
| `--reason ` | no | Reason. |

**Example**

kf schedule resume-job --tenant tnt_demo --actor-type USER --actor-id usr_sam --schedule-id 

## kf schedule upsert-job

Create or update a tenant-owned recurring schedule.

Create or update a tenant-owned recurring schedule. Schedules materialize deterministic jobs for ingestion, extracts, analytics, reconciliation, retention, and connector health.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--schedule-id ` | no | Schedule id. |
| `--schedule-key ` | yes | Schedule key. |
| `--job-type ` | yes | Job type. |
| `--schedule-type ` | yes | Schedule type. |
| `--schedule-config ` | yes | Schedule config. |
| `--payload-template ` | no | Payload template. |
| `--max-attempts ` | no | Max attempts. |
| `--next-run-on ` | yes | ISO date/time |
| `--status ` | no | Status. |
| `--status-reason ` | no | Status reason. |

**Example**

kf schedule upsert-job --tenant tnt_demo --actor-type USER --actor-id usr_sam --schedule-key  --job-type  --schedule-type  --schedule-config  --next-run-on

---

## kf tenant

URL: https://www.karmanflow.com/developers/reference/cli/tenant
Summary: Manage tenant config, locations, API keys, broadcasts, and feeds.

# kf tenant

Manage tenant config, locations, API keys, broadcasts, and feeds.

## kf tenant acknowledge-admin-broadcast-delivery

Record recipient acknowledgement for one app feed delivery.

Record recipient acknowledgement for one app feed delivery. Version-checked and idempotent; the emitted event carries only delivery ids and status facts.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--delivery-id ` | yes | Delivery id. |
| `--expected-version ` | yes | Expected version. |
| `--web-session-id ` | no | Web session id. |
| `--app-user-session-id ` | no | App user session id. |

**Example**

kf tenant acknowledge-admin-broadcast-delivery --tenant tnt_demo --actor-type USER --actor-id usr_sam --delivery-id  --expected-version 

## kf tenant cleanup-sample-data

Delete the rows the trial demo bootstrap stamped with custom_fields['karmanflow:source'] = 'trial-bootstrap' for a single tenant.

Delete the rows the trial demo bootstrap stamped with custom_fields['karmanflow:source'] = 'trial-bootstrap' for a single tenant. Lets an operator clear seeded sample data before they import their own catalog. Walks channel_availabilities, inventory_levels, product_variants, products, and locations in dependency order. Cannot touch operator-authored rows because tenant custom_fields never use the karmanflow: prefix. Idempotent on replay; a second call after a successful cleanup finds no marker rows and returns counts of 0.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |

**Example**

kf tenant cleanup-sample-data --tenant tnt_demo --actor-type USER --actor-id usr_sam

## kf tenant create-api-key

Issue an environment-pinned API key for a service, agent, connector, partner, or extension.

Issue an environment-pinned API key for a service, agent, connector, partner, or extension. The key prefix is derived from the tenant environment type and the raw secret is only returned once.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--display-name ` | yes | Display name. |
| `--subject-type ` | yes | Subject type. |
| `--subject-id ` | yes | Subject id. |
| `--scopes ` | no | Scopes. |
| `--constraints ` | no | Constraints. |
| `--expires-on ` | no | Expires on. |

**Example**

kf tenant create-api-key --tenant tnt_demo --actor-type USER --actor-id usr_sam --display-name  --subject-type  --subject-id 

## kf tenant create-location

Create a Location (store, warehouse, 3PL, dropship, virtual node).

Create a Location (store, warehouse, 3PL, dropship, virtual node). Tenant-scoped uniqueness on locationRef. Idempotent by metadata.idempotencyKey; replays return the prior receipt and reject keys reused for a different locationId.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--location-id ` | no | Location id. |
| `--location-ref ` | yes | Location ref. |
| `--name ` | yes | Name. |
| `--location-type ` | yes | Location type. |
| `--status ` | no | Status. |
| `--pickup-enabled ` | no | Pickup enabled. |
| `--ship-from-store-enabled ` | no | Ship from store enabled. |
| `--service-enabled ` | no | Service enabled. |
| `--trust-level ` | no | Trust level. |
| `--country ` | no | Country. |
| `--state ` | no | State. |
| `--city ` | no | City. |
| `--postal-code ` | no | Postal code. |
| `--address-line1 ` | no | Address line1. |
| `--address-line2 ` | no | Address line2. |
| `--region-code ` | no | Region code. |
| `--latitude ` | no | Latitude. |
| `--longitude ` | no | Longitude. |
| `--time-zone ` | no | Time zone. |
| `--handling-cutoff-local-time ` | no | Handling cutoff local time. |
| `--phone ` | no | Phone. |
| `--email ` | no | Email. |
| `--contact-party-id ` | no | Contact party id. |
| `--lot-tracking-enabled ` | no | Lot tracking enabled. |
| `--serial-tracking-enabled ` | no | Serial tracking enabled. |
| `--temperature-controlled ` | no | Temperature controlled. |
| `--hazmat-certified ` | no | Hazmat certified. |
| `--alcohol-licensed ` | no | Alcohol licensed. |
| `--cold-chain ` | no | Cold chain. |
| `--cross-dock-capable ` | no | Cross dock capable. |
| `--is-return-destination ` | no | Is return destination. |
| `--is-transfer-destination ` | no | Is transfer destination. |
| `--capacity-units ` | no | Capacity units. |
| `--capacity-pallets ` | no | Capacity pallets. |
| `--capacity-sq-ft ` | no | Capacity sq ft. |
| `--parent-location-id ` | no | Parent location id. |
| `--tax-jurisdiction-ref ` | no | Tax jurisdiction ref. |
| `--opened-on ` | no | Opened on. |
| `--custom-fields ` | no | not accepted for this command |

**Example**

kf tenant create-location --tenant tnt_demo --actor-type USER --actor-id usr_sam --location-ref  --name  --location-type 

## kf tenant decommission-location

Terminally decommission a Location.

Terminally decommission a Location. Sets status=DECOMMISSIONED, stamps decommissionedOn and closedOn, emits location.decommissioned. Optimistic concurrency on expectedVersion. Approval required because decommissioning is irreversible and removes the site from routing eligibility.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--location-id ` | yes | Location id. |
| `--reason ` | no | Reason. |
| `--closed-on ` | no | Closed on. |
| `--decommissioned-on ` | no | Decommissioned on. |
| `--expected-version ` | yes | Expected version. |

**Example**

kf tenant decommission-location --tenant tnt_demo --actor-type USER --actor-id usr_sam --location-id  --expected-version 

## kf tenant define-feed

Register a typed FeedDefinition catalog row.

Register a typed FeedDefinition catalog row. Tenant-scoped (or platform-shared via tenant_id '*') uniqueness on feedKey. Carries eventTypes, payload schema reference and version, requiredScopes, riskClass, default backpressure mode, and replay window. Idempotent by metadata.idempotencyKey; replays return the prior receipt and reject keys reused for a different explicit feedDefinitionId. Subscription lifecycle ships in Phase 3+.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--feed-definition-id ` | no | Feed definition id. |
| `--feed-key ` | yes | Feed key. |
| `--name ` | yes | Name. |
| `--description ` | no | Description. |
| `--domain-scope ` | no | Domain scope. |
| `--event-types ` | yes | Event types. |
| `--payload-schema-ref ` | yes | Payload schema ref. |
| `--payload-version ` | no | Payload version. |
| `--required-scopes ` | no | Required scopes. |
| `--risk-class ` | yes | Risk class. |
| `--default-backpressure-mode ` | yes | Default backpressure mode. |
| `--replay-window-seconds ` | no | Replay window seconds. |

**Example**

kf tenant define-feed --tenant tnt_demo --actor-type USER --actor-id usr_sam --feed-key  --name  --event-types  --payload-schema-ref  --risk-class  --default-backpressure-mode 

## kf tenant delete-custom-field

Delete, tombstone, or redact a typed custom field with an auditable command receipt and CustomFieldDeleted event.

Delete, tombstone, or redact a typed custom field with an auditable command receipt and CustomFieldDeleted event. Scoped by tenant and environment.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--entity-type ` | yes | Entity type. |
| `--entity-id ` | yes | Entity id. |
| `--field-key ` | yes | Field key. |
| `--mode ` | no | Mode. |
| `--reason-code ` | no | Reason code. |
| `--expected-version ` | no | Expected version. |

**Example**

kf tenant delete-custom-field --tenant tnt_demo --actor-type USER --actor-id usr_sam --entity-type  --entity-id  --field-key 

## kf tenant deprecate-feed-definition

Mark a FeedDefinition deprecated.

Mark a FeedDefinition deprecated. Phase 2 records deprecation through the emitted event audit trail (no schema change to feed_definitions). Optional replacementFeedKey hint. Optimistic concurrency on expectedVersion; the row's version bumps so future operations see the marker. Subscription dispatch will refuse new subs to deprecated feeds when subscription lifecycle commands land.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--feed-definition-id ` | yes | Feed definition id. |
| `--expected-version ` | yes | Expected version. |
| `--replacement-feed-key ` | no | Replacement feed key. |

**Example**

kf tenant deprecate-feed-definition --tenant tnt_demo --actor-type USER --actor-id usr_sam --feed-definition-id  --expected-version 

## kf tenant dismiss-admin-broadcast-delivery

Record recipient dismissal for one app feed delivery.

Record recipient dismissal for one app feed delivery. Version-checked and idempotent; user actors can dismiss only their own delivery unless they hold admin broadcast authority.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--delivery-id ` | yes | Delivery id. |
| `--expected-version ` | yes | Expected version. |
| `--web-session-id ` | no | Web session id. |
| `--app-user-session-id ` | no | App user session id. |

**Example**

kf tenant dismiss-admin-broadcast-delivery --tenant tnt_demo --actor-type USER --actor-id usr_sam --delivery-id  --expected-version 

## kf tenant extend-trial

Self-serve trial extension.

Self-serve trial extension. Single-shot per trial: bumps trial_expires_on and trial_purges_on by +7 days, sets trial_extension_used=true, emits trial.tenant.extended. Refuses on non-trial tenants and on tenants whose purge horizon has already passed. Idempotent: subsequent calls return the current horizons with alreadyExtended=true rather than granting a second extension.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |

**Example**

kf tenant extend-trial --tenant tnt_demo --actor-type USER --actor-id usr_sam

## kf tenant freeze-trial

Flip a trial tenant from ACTIVE to FROZEN at day 14 (read-only state).

Flip a trial tenant from ACTIVE to FROZEN at day 14 (read-only state). SYSTEM-only; called by the scheduler-worker when trial_expires_on <= now() on a trial=true tenant. Existing auth checks already reject sessions on non-ACTIVE tenants, which gives the read-only effect for free. Idempotent on already-frozen tenants. Refuses on non-trial or DEACTIVATED tenants.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--reason ` | yes | Reason. |

**Example**

kf tenant freeze-trial --tenant tnt_demo --actor-type USER --actor-id usr_sam --reason 

## kf tenant issue-partner-widget-token

Issue a short-lived, environment-pinned signed token for a partner embed widget.

Issue a short-lived, environment-pinned signed token for a partner embed widget. The raw bearer token is returned once; command receipts and events persist only sanitized metadata. Approval-gated: the approval is bound to commandType=IssuePartnerWidgetToken and resourceId=<tenantId>:<environmentId>, with a 1h TTL. Disposition A per the internal implementation notes.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--scope ` | no | Scope. |
| `--widget ` | no | Widget. |
| `--expires-in-seconds ` | no | Expires in seconds. |

**Example**

kf tenant issue-partner-widget-token --tenant tnt_demo --actor-type USER --actor-id usr_sam

## kf tenant mark-admin-broadcast-delivery-delivered

Mark one queued app feed delivery as delivered for the recipient app surface.

Mark one queued app feed delivery as delivered for the recipient app surface. Version-checked and idempotent; user actors can update only their own delivery unless they hold admin broadcast authority.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--delivery-id ` | yes | Delivery id. |
| `--expected-version ` | yes | Expected version. |
| `--web-session-id ` | no | Web session id. |
| `--app-user-session-id ` | no | App user session id. |

**Example**

kf tenant mark-admin-broadcast-delivery-delivered --tenant tnt_demo --actor-type USER --actor-id usr_sam --delivery-id  --expected-version 

## kf tenant promote-config

Copy an approved tenant-config value from a source environment to a target environment (e.g., sandbox -> prod) with full receipt, history row, and linked audit event.

Copy an approved tenant-config value from a source environment to a target environment (e.g., sandbox -> prod) with full receipt, history row, and linked audit event. Source and target environments must differ; target must be ACTIVE.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--source-environment-id ` | yes | Source environment id. |
| `--target-environment-id ` | yes | Target environment id. |
| `--config-keys ` | no | Config keys. |

**Example**

kf tenant promote-config --tenant tnt_demo --actor-type USER --actor-id usr_sam --source-environment-id  --target-environment-id 

## kf tenant record-app-user-session-heartbeat

Record or refresh one active app user session for app and tenant-admin visibility.

Record or refresh one active app user session for app and tenant-admin visibility. User actors can record only their own web session unless they hold admin activity authority. Event payloads omit user agent and IP hash.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--web-session-id ` | yes | Web session id. |
| `--app-installation-id ` | no | App installation id. |
| `--app-id ` | no | App id. |
| `--app-surface ` | yes | App surface. |
| `--device-type ` | no | Device type. |
| `--device-label ` | no | Device label. |
| `--browser-name ` | no | Browser name. |
| `--os-name ` | no | Os name. |
| `--user-agent ` | no | User agent. |
| `--ip-hash ` | no | Ip hash. |
| `--occurred-on ` | no | ISO date/time |

**Example**

kf tenant record-app-user-session-heartbeat --tenant tnt_demo --actor-type USER --actor-id usr_sam --web-session-id  --app-surface 

## kf tenant revoke-api-key

Immediately revoke an active environment API key.

Immediately revoke an active environment API key. Revoked keys fail runtime authentication and leave a command receipt plus api_key.revoked event.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--api-key-id-stdin` | yes | Read Api key id. from stdin. |
| `--expected-version ` | yes | Expected version. |
| `--reason ` | yes | Reason. |

**Example**

kf tenant revoke-api-key --tenant tnt_demo --actor-type USER --actor-id usr_sam --api-key-id-stdin --expected-version  --reason 

## kf tenant rollback-feed-definition

Roll a FeedDefinition's payload_version back to a prior value (target must be strictly less than current).

Roll a FeedDefinition's payload_version back to a prior value (target must be strictly less than current). Optimistic concurrency on expectedVersion. Carries a reasonCode for audit. Forward rolls are rejected; use UpdateFeedDefinition to advance.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--feed-definition-id ` | yes | Feed definition id. |
| `--target-payload-version ` | yes | Target payload version. |
| `--expected-version ` | yes | Expected version. |
| `--reason-code ` | yes | Reason code. |

**Example**

kf tenant rollback-feed-definition --tenant tnt_demo --actor-type USER --actor-id usr_sam --feed-definition-id  --target-payload-version  --expected-version  --reason-code 

## kf tenant rotate-api-key

Rotate an active environment API key.

Rotate an active environment API key. Marks the previous key as ROTATED, creates a new key with the same subject and scopes, and returns the new secret once.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--api-key-id-stdin` | yes | Read Api key id. from stdin. |
| `--expected-version ` | yes | Expected version. |
| `--display-name ` | no | Display name. |
| `--expires-on ` | no | Expires on. |

**Example**

kf tenant rotate-api-key --tenant tnt_demo --actor-type USER --actor-id usr_sam --api-key-id-stdin --expected-version 

## kf tenant send-admin-broadcast

Send a tenant-admin app feed item to active app users by tenant, app, role, or user target.

Send a tenant-admin app feed item to active app users by tenant, app, role, or user target. Stores content, category, badge, CTA, and trigger refs on admin_broadcasts, creates delivery rows, and emits only sanitized target and feed facts.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--title ` | yes | Title. |
| `--body ` | yes | Body. |
| `--severity ` | no | Severity. |
| `--feed-category ` | no | Feed category. |
| `--feed-badge-label ` | no | Feed badge label. |
| `--feed-badge-tone ` | no | Feed badge tone. |
| `--action-label ` | no | Action label. |
| `--action-url ` | no | Action url. |
| `--action-route-ref ` | no | Action route ref. |
| `--action-payload ` | no | Action payload. |
| `--source-app-installation-id ` | no | Source app installation id. |
| `--source-event-id ` | no | Source event id. |
| `--trigger-event-type ` | no | Trigger event type. |
| `--trigger-entity-type ` | no | Trigger entity type. |
| `--trigger-entity-id ` | no | Trigger entity id. |
| `--feed-metadata ` | no | Feed metadata. |
| `--target-scope ` | no | Target scope. |
| `--target-app-installation-id ` | no | Target app installation id. |
| `--target-role ` | no | Target role. |
| `--target-user-id ` | no | Target user id. |
| `--expires-on ` | no | ISO date/time |

**Example**

kf tenant send-admin-broadcast --tenant tnt_demo --actor-type USER --actor-id usr_sam --title  --body 

## kf tenant transition-location-status

Transition a Location between ACTIVE and INACTIVE with optimistic concurrency on expectedVersion.

Transition a Location between ACTIVE and INACTIVE with optimistic concurrency on expectedVersion. Emits location.inactivated or location.reactivated.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--location-id ` | yes | Location id. |
| `--target-status ` | yes | Target status. |
| `--expected-version ` | yes | Expected version. |

**Example**

kf tenant transition-location-status --tenant tnt_demo --actor-type USER --actor-id usr_sam --location-id  --target-status  --expected-version 

## kf tenant update-config

Update mutable tenant configuration: shallow-merge feature flags, write policy overrides and channel defaults through tenant_configs sidecars.

Update mutable tenant configuration: shallow-merge feature flags, write policy overrides and channel defaults through tenant_configs sidecars. Version-CAS on the tenants row.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--feature-flags ` | no | Feature flags. |
| `--policy-overrides ` | no | Policy overrides. |
| `--channel-defaults ` | no | Channel defaults. |
| `--expected-version ` | yes | Expected version. |

**Example**

kf tenant update-config --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version 

## kf tenant update-feed-definition

Update a FeedDefinition's mutable fields (name, description, domainScope, eventTypes, payloadSchemaRef, payloadVersion, requiredScopes, riskClass, defaultBackpressureMode, replayWindowSeconds).

Update a FeedDefinition's mutable fields (name, description, domainScope, eventTypes, payloadSchemaRef, payloadVersion, requiredScopes, riskClass, defaultBackpressureMode, replayWindowSeconds). Optimistic concurrency on expectedVersion. Records the changed-field set and the old/new payloadVersion in the emitted event so subscribers can negotiate schema changes.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |

**Example**

kf tenant update-feed-definition --tenant tnt_demo --actor-type USER --actor-id usr_sam

## kf tenant update-location

Update a Location's mutable fields (locationRef, name, type, fulfillment capability flags, trust level, address).

Update a Location's mutable fields (locationRef, name, type, fulfillment capability flags, trust level, address). Optimistic concurrency on expectedVersion. Status transitions belong to TransitionLocationStatus.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--location-id ` | yes | Location id. |
| `--location-ref ` | no | Location ref. |
| `--name ` | no | Name. |
| `--location-type ` | no | Location type. |
| `--pickup-enabled ` | no | Pickup enabled. |
| `--ship-from-store-enabled ` | no | Ship from store enabled. |
| `--service-enabled ` | no | Service enabled. |
| `--trust-level ` | no | Trust level. |
| `--country ` | no | Country. |
| `--state ` | no | State. |
| `--city ` | no | City. |
| `--postal-code ` | no | Postal code. |
| `--address-line1 ` | no | Address line1. |
| `--address-line2 ` | no | Address line2. |
| `--region-code ` | no | Region code. |
| `--latitude ` | no | Latitude. |
| `--longitude ` | no | Longitude. |
| `--time-zone ` | no | Time zone. |
| `--handling-cutoff-local-time ` | no | Handling cutoff local time. |
| `--phone ` | no | Phone. |
| `--email ` | no | Email. |
| `--contact-party-id ` | no | Contact party id. |
| `--lot-tracking-enabled ` | no | Lot tracking enabled. |
| `--serial-tracking-enabled ` | no | Serial tracking enabled. |
| `--temperature-controlled ` | no | Temperature controlled. |
| `--hazmat-certified ` | no | Hazmat certified. |
| `--alcohol-licensed ` | no | Alcohol licensed. |
| `--cold-chain ` | no | Cold chain. |
| `--cross-dock-capable ` | no | Cross dock capable. |
| `--is-return-destination ` | no | Is return destination. |
| `--is-transfer-destination ` | no | Is transfer destination. |
| `--capacity-units ` | no | Capacity units. |
| `--capacity-pallets ` | no | Capacity pallets. |
| `--capacity-sq-ft ` | no | Capacity sq ft. |
| `--parent-location-id ` | no | Parent location id. |
| `--tax-jurisdiction-ref ` | no | Tax jurisdiction ref. |
| `--opened-on ` | no | Opened on. |
| `--closed-on ` | no | Closed on. |
| `--custom-fields ` | no | not accepted for this command |
| `--expected-version ` | yes | Expected version. |

**Example**

kf tenant update-location --tenant tnt_demo --actor-type USER --actor-id usr_sam --location-id  --expected-version 

## kf tenant upsert-bundle-allocation-policy

Create or update a per-tenant per-environment BundleAllocationPolicy controlling substitution mode (NEVER/ON_FAILURE_WITH_APPROVAL/AUTO_IF_PREDICATE_MATCHES), partial-fulfillment mode, reservation timeout, and overbooking policy.

Create or update a per-tenant per-environment BundleAllocationPolicy controlling substitution mode (NEVER/ON_FAILURE_WITH_APPROVAL/AUTO_IF_PREDICATE_MATCHES), partial-fulfillment mode, reservation timeout, and overbooking policy. Default policy denies substitution and partial fulfillment until tenants opt in.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--policy-key ` | yes | Policy key. |
| `--substitution-mode ` | yes | Substitution mode. |
| `--partial-fulfillment-mode ` | yes | Partial fulfillment mode. |
| `--reservation-timeout-minutes ` | no | Reservation timeout minutes. |
| `--overbooking-policy ` | no | Overbooking policy. |
| `--overbooking-config ` | no | Overbooking config. |

**Example**

kf tenant upsert-bundle-allocation-policy --tenant tnt_demo --actor-type USER --actor-id usr_sam --policy-key  --substitution-mode  --partial-fulfillment-mode 

## kf tenant upsert-config

Create or update a tenant-scoped configuration entry.

Create or update a tenant-scoped configuration entry. Skills, policy, and UI read from this for per-tenant behavior.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--config-key ` | yes | Config key. |
| `--value ` | yes | Value. |
| `--description ` | no | Description. |
| `--expected-version ` | yes | Expected version. |

**Example**

kf tenant upsert-config --tenant tnt_demo --actor-type USER --actor-id usr_sam --config-key  --value  --expected-version 

## kf tenant upsert-custom-field

Create or update a typed custom field against a canonical entity (ProductVariant, InventoryLevel, Location, and peers).

Create or update a typed custom field against a canonical entity (ProductVariant, InventoryLevel, Location, and peers). Validates namespace authority before writing and rejects unknown namespaces. Idempotent per metadata.idempotencyKey.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--entity-type ` | yes | Entity type. |
| `--entity-id ` | yes | Entity id. |
| `--namespace ` | yes | Namespace. |
| `--key ` | yes | Key. |
| `--value-type ` | yes | Value type. |
| `--string-value ` | no | String value. |
| `--number-value ` | no | Number value. |
| `--boolean-value ` | no | Boolean value. |
| `--date-value ` | no | Date value. |
| `--json-value ` | no | Json value. |
| `--field-group ` | no | Field group. |
| `--is-indexed ` | no | Is indexed. |
| `--source-system ` | no | Source system. |
| `--expected-version ` | no | Expected version. |

**Example**

kf tenant upsert-custom-field --tenant tnt_demo --actor-type USER --actor-id usr_sam --entity-type  --entity-id  --namespace  --key  --value-type 

## kf tenant upsert-environment

Create or update a tenant environment and its deployment routing profile.

Create or update a tenant environment and its deployment routing profile. This is the command-backed control-plane seam for tenant, lifecycle environment, and physical deployment isolation.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--environment-key ` | no | Environment key. |
| `--environment-type ` | yes | Environment type. |
| `--name ` | no | Name. |
| `--status ` | no | Status. |
| `--lifecycle-stage ` | no | Lifecycle stage. |
| `--data-classification ` | no | Data classification. |
| `--source-environment-id ` | no | Source environment id. |
| `--promotion-policy-ref ` | no | Promotion policy ref. |
| `--retention-policy-ref ` | no | Retention policy ref. |
| `--deletion-policy-ref ` | no | Deletion policy ref. |
| `--environment-metadata ` | no | Environment metadata. |
| `--expected-environment-version ` | yes | Expected environment version. |
| `--deployment ` | no | Deployment. |

**Example**

kf tenant upsert-environment --tenant tnt_demo --actor-type USER --actor-id usr_sam --environment-type  --expected-environment-version 

## kf tenant upsert-location-operating-exception

Create or update a single calendar-date operating-hours override for a Location (holiday closure or special hours).

Create or update a single calendar-date operating-hours override for a Location (holiday closure or special hours). Idempotent by metadata.idempotencyKey. Emits location.operating_exception_upserted.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--location-id ` | yes | Location id. |
| `--exception-date ` | yes | Exception date. |
| `--is-closed ` | no | Is closed. |
| `--opens-at ` | no | Opens at. |
| `--closes-at ` | no | Closes at. |
| `--reason ` | no | Reason. |

**Example**

kf tenant upsert-location-operating-exception --tenant tnt_demo --actor-type USER --actor-id usr_sam --location-id  --exception-date 

## kf tenant upsert-location-operating-hours

Replace the weekly recurring operating-hours schedule for a Location atomically.

Replace the weekly recurring operating-hours schedule for a Location atomically. Accepts up to 21 (day_of_week, opens_at, closes_at, isClosed, shiftLabel?, effectiveFrom?, effectiveTo?) entries; the existing schedule is deleted and the new one inserted in one transaction. Idempotent by metadata.idempotencyKey. Emits location.operating_hours_upserted.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--location-id ` | yes | Location id. |
| `--expected-version ` | yes | Expected version. |
| `--hours ` | yes | Hours. |

**Example**

kf tenant upsert-location-operating-hours --tenant tnt_demo --actor-type USER --actor-id usr_sam --location-id  --expected-version  --hours

---

## kf tenant-defaults

URL: https://www.karmanflow.com/developers/reference/cli/tenant-defaults
Summary: Configure persona-driven tenant defaults.

# kf tenant-defaults

Configure persona-driven tenant defaults.

## kf tenant-defaults configure

Persona-driven day-0 bootstrap.

Persona-driven day-0 bootstrap. Writes tenant_configs rows for oversell, reservation TTL, and availability safety stock, creates the persona's default locations and sales channels, and installs the persona's default agents in Observer mode. Idempotent on metadata.idempotencyKey; callers may supply overrides to replace any default field.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--persona ` | yes | Persona. |
| `--overrides ` | no | Overrides. |

**Example**

kf tenant-defaults configure --tenant tnt_demo --actor-type USER --actor-id usr_sam --persona

---

## kf trace

URL: https://www.karmanflow.com/developers/reference/cli/trace
Summary: Read bounded inventory-to-order proof packets.

# kf trace

Pulls receipts, events, inventory movements, and ingestion records into one timeline anchored on a selector.

## kf trace flow

Read one bounded inventory to order proof packet through GraphQL.

At least one selector is required.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id. |
| `--inventory-level-id ` | no | Inventory level selector. |
| `--reservation-id ` | no | Reservation selector. |
| `--order-id ` | no | Order selector. |
| `--fulfillment-order-id ` | no | Fulfillment order selector. |
| `--ingestion-run-id ` | no | Ingestion run selector. |
| `--command-id ` | no | Command id selector. |
| `--correlation-id ` | no | Correlation id selector. |
| `--limit ` | no | Result cap, default 100. |

**Example**

kf trace flow --tenant tnt_demo --order-id ord_01

---

## kf version

URL: https://www.karmanflow.com/developers/reference/cli/version
Summary: Print CLI version metadata.

# kf version

Reports the CLI binary name, package name, version, and the capability list this build supports.

## kf version

Print CLI version metadata.

No flags. Always reads the embedded build version.

**Example**

kf version --pretty

---

## kf webhook

URL: https://www.karmanflow.com/developers/reference/cli/webhook
Summary: Subscribe to, pause, replay, and rotate webhook deliveries.

# kf webhook

Subscribe to, pause, replay, and rotate webhook deliveries.

## kf webhook pause-subscription

Pause an active webhook subscription.

Pause an active webhook subscription. No deliveries are attempted while paused.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--webhook-subscription-id ` | yes | Webhook subscription id. |

**Example**

kf webhook pause-subscription --tenant tnt_demo --actor-type USER --actor-id usr_sam --webhook-subscription-id 

## kf webhook replay-delivery

Redrive a scheduled or dead-lettered webhook delivery by moving it back to PENDING for the delivery worker.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--webhook-delivery-id ` | yes | Webhook delivery id. |
| `--reset-attempts ` | no | Reset attempts. |

**Example**

kf webhook replay-delivery --tenant tnt_demo --actor-type USER --actor-id usr_sam --webhook-delivery-id 

## kf webhook resume-subscription

Resume a paused webhook subscription.

Resume a paused webhook subscription. Deliveries resume from the next event.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--webhook-subscription-id ` | yes | Webhook subscription id. |

**Example**

kf webhook resume-subscription --tenant tnt_demo --actor-type USER --actor-id usr_sam --webhook-subscription-id 

## kf webhook rotate-subscription-secret

Issue a fresh HMAC signing secret for a webhook subscription.

Issue a fresh HMAC signing secret for a webhook subscription. The new secret is returned exactly once in the command response; idempotent replays return null. Approval-gated: the approval is bound to `commandType=RotateWebhookSubscriptionSecret` and `resourceId=webhookSubscriptionId` within the tenant environment. TTL is per-request via `dueOn`/`expiresOn`, not fixed by the command.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--webhook-subscription-id ` | yes | Webhook subscription id. |

**Example**

kf webhook rotate-subscription-secret --tenant tnt_demo --actor-type USER --actor-id usr_sam --webhook-subscription-id 

## kf webhook upsert-subscription

Create or update a webhook subscription for a tenant.

Create or update a webhook subscription for a tenant. Defines event pattern, target URL, delivery mode, and signing secret reference.

| Flag | Required | Description |
| --- | --- | --- |
| `--tenant ` | yes | Target tenant id. |
| `--environment ` | no | Target environment id; defaults to the active profile environment. |
| `--actor-type ` | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
| `--actor-id ` | yes | Actor id. |
| `--idempotency-key ` | no | Idempotency key for safe retries. Generated when omitted. |
| `--webhook-subscription-id ` | no | Webhook subscription id. |
| `--event-pattern ` | yes | Event pattern. |
| `--target-url ` | yes | Target url. |
| `--signing-secret-ref-stdin` | yes | Read Signing secret ref. from stdin. |
| `--delivery-mode ` | yes | Delivery mode. |
| `--status ` | yes | Status. |

**Example**

kf webhook upsert-subscription --tenant tnt_demo --actor-type USER --actor-id usr_sam --event-pattern  --target-url  --signing-secret-ref-stdin --delivery-mode  --status

---

## GraphQL reference

URL: https://www.karmanflow.com/developers/reference/graphql
Summary: Hosted index for the KarmanFlow GraphQL reference.

# GraphQL reference

Hosted schema reference for the KarmanFlow public preview. Sections are split so the sidebar stays readable even at full schema size.

- [GraphQL queries](/developers/reference/graphql/queries): 144 entries.
- [GraphQL mutations](/developers/reference/graphql/mutations): 170 entries.
- [GraphQL object types](/developers/reference/graphql/types): 265 entries.
- [GraphQL input types](/developers/reference/graphql/inputs): 153 entries.
- [GraphQL enums](/developers/reference/graphql/enums): 1 entry.
- [GraphQL scalars](/developers/reference/graphql/scalars): 3 entries.

---

## GraphQL enums

URL: https://www.karmanflow.com/developers/reference/graphql/enums
Summary: Enum types in the KarmanFlow GraphQL schema.

# GraphQL enums

Enum types in the KarmanFlow GraphQL schema.

## AnalyticsAlertScope

| Value | Description |
| --- | --- |
| `PLATFORM` |  |
| `TENANT` |  |

---

## GraphQL input types

URL: https://www.karmanflow.com/developers/reference/graphql/inputs
Summary: Input object types in the KarmanFlow GraphQL schema.

# GraphQL input types

Input object types in the KarmanFlow GraphQL schema.

## AcknowledgeIncidentInput

| Field | Type | Description |
| --- | --- | --- |
| `acknowledgedBy` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `incidentId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String!` |  |
| `tenantId` | `String!` |  |

## ActivateAsShopifyFulfillmentServiceInput

| Field | Type | Description |
| --- | --- | --- |
| `bindingId` | `ID!` |  |
| `callbackUrl` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `shopifyFulfillmentServiceId` | `Int!` |  |
| `shopifyLocationId` | `Int!` |  |
| `tenantId` | `String!` |  |

## AddShopifyShopInput

| Field | Type | Description |
| --- | --- | --- |
| `accessTokenSecretRef` | `String!` |  |
| `installedByActorId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `scope` | `[String!]!` |  |
| `shopDomain` | `String!` |  |
| `tenantId` | `String!` |  |

## AdjustInventoryInput

| Field | Type | Description |
| --- | --- | --- |
| `delta` | `Float!` |  |
| `expectedVersion` | `Int!` |  |
| `inventoryLevelId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `quantityType` | `String!` | ON_HAND \| RESERVED \| ALLOCATED |
| `reasonCode` | `String` |  |
| `tenantId` | `String!` |  |

## AdvanceOnboardingStepInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `nextStepId` | `String!` |  |
| `stepId` | `String!` |  |
| `tenantId` | `String!` |  |

## AllocateFulfillmentOrderInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `fulfillmentOrderId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## AnalyticsExportBucketRangeInput

| Field | Type | Description |
| --- | --- | --- |
| `bucketType` | `String!` |  |
| `from` | `DateTime!` |  |
| `to` | `DateTime!` |  |

## AppFeedItemStateInput

| Field | Type | Description |
| --- | --- | --- |
| `appUserSessionId` | `String` |  |
| `deliveryId` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |
| `webSessionId` | `String` |  |

## ApplyCountVarianceInput

| Field | Type | Description |
| --- | --- | --- |
| `countLineId` | `String!` |  |
| `countSessionId` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `inventoryLevelId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reasonCode` | `String` |  |
| `tenantId` | `String!` |  |

## ApproveProgressiveActionInput

| Field | Type | Description |
| --- | --- | --- |
| `actionId` | `ID!` |  |
| `approvalId` | `ID` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `note` | `String` |  |
| `tenantId` | `String!` |  |

## AssignPartyRoleInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `partyId` | `ID!` |  |
| `roleType` | `String!` |  |
| `scopeId` | `ID` |  |
| `scopeType` | `String!` |  |
| `tenantId` | `String!` |  |
| `validFrom` | `DateTime` |  |
| `validTo` | `DateTime` |  |

## AuthorizeReturnInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `returnId` | `ID!` |  |
| `tenantId` | `String!` |  |

## BuildContextPackInput

| Field | Type | Description |
| --- | --- | --- |
| `entityId` | `String` |  |
| `entityType` | `String` |  |
| `eventLimit` | `Int` |  |
| `locale` | `String` |  |

## BuildCustomerServiceContextInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `requestId` | `ID!` |  |
| `tenantId` | `String!` |  |

## CancelAnalyticsExportInput

| Field | Type | Description |
| --- | --- | --- |
| `exportId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String!` |  |
| `tenantId` | `String!` |  |

## CancelFulfillmentOrderInput

| Field | Type | Description |
| --- | --- | --- |
| `cancellationReason` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `fulfillmentOrderId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## CancelFutureSupplyInput

| Field | Type | Description |
| --- | --- | --- |
| `cancellationReason` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `futureQuantityId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## CancelJobScheduleInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String` |  |
| `scheduleId` | `ID!` |  |
| `tenantId` | `String!` |  |

## CancelReturnInput

| Field | Type | Description |
| --- | --- | --- |
| `cancellationReason` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `returnId` | `ID!` |  |
| `tenantId` | `String!` |  |

## CancelStockTransferInput

| Field | Type | Description |
| --- | --- | --- |
| `cancellationReason` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `stockTransferId` | `ID!` |  |
| `tenantId` | `String!` |  |

## CleanupSampleDataInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## ClearSampleDataInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String!` |  |
| `tenantId` | `String!` |  |

## CloseCountSessionInput

| Field | Type | Description |
| --- | --- | --- |
| `action` | `String!` |  |
| `countSessionId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `note` | `String` |  |
| `tenantId` | `String!` |  |

## CommandMetadataInput

| Field | Type | Description |
| --- | --- | --- |
| `actorId` | `String!` |  |
| `actorType` | `String!` |  |
| `causationId` | `String!` |  |
| `correlationId` | `String!` |  |
| `idempotencyKey` | `String!` |  |
| `policyContext` | `JSON` |  |
| `traceparent` | `String` |  |

## CommitBundleReservationInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `orderId` | `ID!` |  |
| `reservationGroupId` | `ID!` |  |
| `tenantId` | `String!` |  |

## CommitReservationInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedReservationVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reasonCode` | `String` |  |
| `reservationId` | `ID!` |  |
| `tenantId` | `String!` |  |

## CompleteFulfillmentOrderPackingInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `fulfillmentOrderId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## ComponentReservationInput

| Field | Type | Description |
| --- | --- | --- |
| `acceptBackorder` | `Boolean` |  |
| `bundleComponentId` | `ID!` |  |
| `expectedInventoryLevelVersion` | `Int!` |  |
| `inventoryBinId` | `ID` |  |
| `inventoryLotId` | `ID` |  |
| `inventoryOwnerId` | `ID!` |  |
| `inventorySerialId` | `ID` |  |
| `locationId` | `ID!` |  |
| `referenceId` | `ID` |  |
| `referenceType` | `String` |  |
| `reservationType` | `String!` |  |

## ConfigureTenantDefaultsInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `persona` | `String!` |  |
| `tenantId` | `String!` |  |

## CreateAddressInput

| Field | Type | Description |
| --- | --- | --- |
| `city` | `String` |  |
| `countryCode` | `String!` |  |
| `kind` | `String!` |  |
| `line1` | `String!` |  |
| `line2` | `String` |  |
| `line3` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `partyId` | `ID!` |  |
| `postalCode` | `String` |  |
| `region` | `String` |  |
| `regionCode` | `String` |  |
| `tenantId` | `String!` |  |

## CreateAnalyticsAlertInput

| Field | Type | Description |
| --- | --- | --- |
| `channels` | `[String!]` |  |
| `description` | `String` |  |
| `displayName` | `String!` |  |
| `escalationAfterHours` | `Int` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `muteUntil` | `String` |  |
| `ruleKey` | `String!` |  |
| `scope` | `AnalyticsAlertScope` |  |
| `severity` | `String!` |  |
| `spec` | `JSON!` |  |
| `tenantId` | `String!` |  |

## CreateContactPointInput

| Field | Type | Description |
| --- | --- | --- |
| `contactType` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `partyId` | `ID!` |  |
| `preferred` | `Boolean` |  |
| `preferredLanguage` | `String` |  |
| `preferredLocale` | `String` |  |
| `tenantId` | `String!` |  |
| `value` | `String!` |  |
| `valueNormalized` | `String` |  |

## CreateCustomerServiceRequestInput

| Field | Type | Description |
| --- | --- | --- |
| `addressId` | `ID` |  |
| `channel` | `String!` |  |
| `contactPointId` | `ID` |  |
| `customerPartyId` | `ID` |  |
| `fulfillmentOrderId` | `ID` |  |
| `intentSummary` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `orderId` | `ID` |  |
| `requestClass` | `String!` |  |
| `returnId` | `ID` |  |
| `shipmentId` | `ID` |  |
| `sourceArtifacts` | `JSON` |  |
| `subjectId` | `ID!` |  |
| `subjectType` | `String!` |  |
| `tenantId` | `String!` |  |
| `triggerSource` | `String!` |  |

## CreateDropshipLocationInput

| Field | Type | Description |
| --- | --- | --- |
| `addressLine1` | `String` |  |
| `addressLine2` | `String` |  |
| `city` | `String` |  |
| `connectorKey` | `String` |  |
| `country` | `String` |  |
| `dropshipSupplierPartyId` | `String!` |  |
| `feedType` | `String` |  |
| `locationRef` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `name` | `String!` |  |
| `postalCode` | `String` |  |
| `regionCode` | `String` |  |
| `scheduleCron` | `String` |  |
| `stalenessThresholdSeconds` | `Int` |  |
| `state` | `String` |  |
| `tenantId` | `String!` |  |
| `timeZone` | `String` |  |

## CreateExternalTaskInput

| Field | Type | Description |
| --- | --- | --- |
| `dueOn` | `DateTime` |  |
| `entityId` | `String!` |  |
| `entityType` | `String!` |  |
| `inputPayload` | `JSON!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `targetRef` | `String` |  |
| `targetSystem` | `String!` |  |
| `taskType` | `String!` |  |
| `tenantId` | `String!` |  |

## CreateFulfillmentOrderInput

| Field | Type | Description |
| --- | --- | --- |
| `fulfillmentRef` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `orderId` | `String!` |  |
| `plannedDispatchOn` | `DateTime` |  |
| `priority` | `Int` |  |
| `shipToAddressId` | `String` |  |
| `shipToPartyId` | `String` |  |
| `sourceLocationId` | `String` |  |
| `sourceSystem` | `String` |  |
| `tenantId` | `String!` |  |

## CreateOrderInput

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `String` |  |
| `currency` | `String` |  |
| `lines` | `[CreateOrderLineInput!]!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `orderRef` | `String!` |  |
| `partyId` | `String` |  |
| `tenantId` | `String!` |  |
| `totalMinor` | `BigInt` |  |

## CreateOrderLineInput

| Field | Type | Description |
| --- | --- | --- |
| `orderedQty` | `Float!` |  |
| `reservationId` | `String` |  |
| `variantId` | `String!` |  |

## CreatePartyInput

| Field | Type | Description |
| --- | --- | --- |
| `displayName` | `String` |  |
| `externalRef` | `String` |  |
| `familyName` | `String` |  |
| `givenName` | `String` |  |
| `legalName` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `partyType` | `String!` |  |
| `tenantId` | `String!` |  |

## CreateProductInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `name` | `String!` |  |
| `productId` | `ID` |  |
| `productRef` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String!` |  |

## CreateProductVariantInput

| Field | Type | Description |
| --- | --- | --- |
| `barcode` | `String` |  |
| `defaultShelfLifeDays` | `Int` |  |
| `exportControlClass` | `String` |  |
| `hazmatClass` | `String` |  |
| `hsCode` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `optionValues` | `JSON` |  |
| `productId` | `ID!` |  |
| `requiresExpiryTracking` | `Boolean` |  |
| `requiresLotTracking` | `Boolean` |  |
| `requiresSerialTracking` | `Boolean` |  |
| `sku` | `String!` |  |
| `status` | `String` |  |
| `temperatureZone` | `String` |  |
| `tenantId` | `String!` |  |
| `trackingType` | `String` |  |
| `uom` | `String` |  |
| `variantId` | `ID` |  |

## CreateReservationInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedInventoryLevelVersion` | `Int!` |  |
| `expiresOn` | `DateTime` |  |
| `inventoryBinId` | `String` |  |
| `inventoryLotId` | `String` |  |
| `inventoryOwnerId` | `String!` |  |
| `inventorySerialId` | `String` |  |
| `locationId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `quantity` | `Float!` |  |
| `referenceId` | `String` |  |
| `referenceType` | `String` |  |
| `reservationType` | `String!` |  |
| `tenantId` | `String!` |  |
| `variantId` | `String!` |  |

## CreateReturnInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `orderId` | `ID!` |  |
| `reasonCode` | `String` |  |
| `returnRef` | `String` |  |
| `returnToAddressId` | `ID` |  |
| `returnToLocationId` | `ID` |  |
| `returnerPartyId` | `ID` |  |
| `sourceSystem` | `String` |  |
| `tenantId` | `String!` |  |

## CreateShipmentInput

| Field | Type | Description |
| --- | --- | --- |
| `carrier` | `String` |  |
| `carrierPartyId` | `ID` |  |
| `expectedDeliveryOn` | `DateTime` |  |
| `expectedFulfillmentOrderVersion` | `Int!` |  |
| `fromLocationId` | `ID` |  |
| `fulfillmentOrderId` | `ID!` |  |
| `lines` | `[CreateShipmentLineInput!]` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `packageCount` | `Int` |  |
| `serviceLevel` | `String` |  |
| `shipToAddressId` | `ID` |  |
| `shipmentRef` | `String` |  |
| `tenantId` | `String!` |  |
| `trackingRef` | `String` |  |
| `trackingUrl` | `String` |  |
| `weightGrams` | `Int` |  |

## CreateShipmentLineInput

| Field | Type | Description |
| --- | --- | --- |
| `fulfillmentOrderLineId` | `ID!` |  |
| `packageRef` | `String` |  |
| `quantity` | `Float!` |  |

## CreateStockTransferInput

| Field | Type | Description |
| --- | --- | --- |
| `carrier` | `String` |  |
| `expectedDeliveryOn` | `DateTime` |  |
| `fromInventoryLevelId` | `String!` |  |
| `fromLocationId` | `String!` |  |
| `inventoryOwnerId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `quantity` | `Float!` |  |
| `reasonCode` | `String` |  |
| `shipByOn` | `DateTime` |  |
| `tenantId` | `String!` |  |
| `toInventoryLevelId` | `String!` |  |
| `toLocationId` | `String!` |  |
| `trackingRef` | `String` |  |
| `transferRef` | `String!` |  |
| `variantId` | `String!` |  |

## DeactivateAsShopifyFulfillmentServiceInput

| Field | Type | Description |
| --- | --- | --- |
| `bindingId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## DeactivateChannelOfferInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `offerId` | `ID!` |  |
| `tenantId` | `String!` |  |

## DecommissionLocationInput

| Field | Type | Description |
| --- | --- | --- |
| `closedOn` | `String` |  |
| `decommissionedOn` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `locationId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String` |  |
| `tenantId` | `String!` |  |

## DeleteAnalyticsAlertInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `ruleKey` | `String!` |  |
| `scope` | `AnalyticsAlertScope!` |  |
| `tenantId` | `String!` |  |

## DeleteSavedReportInput

| Field | Type | Description |
| --- | --- | --- |
| `environmentId` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reportKey` | `String!` |  |
| `tenantId` | `String!` |  |

## DelistChannelListingInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `listingId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## DispatchShipmentInput

| Field | Type | Description |
| --- | --- | --- |
| `dispatchedOn` | `DateTime` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `shipmentId` | `ID!` |  |
| `tenantId` | `String!` |  |
| `trackingRef` | `String` |  |
| `trackingUrl` | `String` |  |

## DropshipDeltaLineInput

| Field | Type | Description |
| --- | --- | --- |
| `delta` | `Float!` |  |
| `lotRef` | `String` |  |
| `variantId` | `String!` |  |

## DropshipInventoryLineInput

| Field | Type | Description |
| --- | --- | --- |
| `lotRef` | `String` |  |
| `quantity` | `Float!` |  |
| `variantId` | `String!` |  |

## ErasePartyInput

| Field | Type | Description |
| --- | --- | --- |
| `approvalRequestId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `partyId` | `ID!` |  |
| `reason` | `String` |  |
| `tenantId` | `String!` |  |

## EscalateCustomerServiceRequestInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `ownerTeam` | `String` |  |
| `reason` | `String!` |  |
| `requestId` | `ID!` |  |
| `tenantId` | `String!` |  |

## EscalateIncidentInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `incidentId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String!` |  |
| `tenantId` | `String!` |  |

## ExecuteIncidentActionInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `incidentId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `resolvedCommandReceiptId` | `String!` |  |
| `tenantId` | `String!` |  |

## ExecuteProgressiveActionInput

| Field | Type | Description |
| --- | --- | --- |
| `actionId` | `ID!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## ExpireReservationInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedReservationVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reservationId` | `ID!` |  |
| `tenantId` | `String!` |  |

## FireAhaMomentScenarioInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `scenarioId` | `String` |  |
| `tenantId` | `String!` |  |

## FulfillFulfillmentOrderInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `fulfillmentOrderId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## IgnoreShopifyDriftEventInput

| Field | Type | Description |
| --- | --- | --- |
| `aggregateType` | `String!` |  |
| `bindingId` | `ID!` |  |
| `dismissedReason` | `String` |  |
| `driftEventId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `partnerAggregateId` | `String!` |  |
| `tenantId` | `String!` |  |

## IngestDropshipDeltaInput

| Field | Type | Description |
| --- | --- | --- |
| `feedId` | `String!` |  |
| `inventoryOwnerKey` | `String` |  |
| `lines` | `[DropshipDeltaLineInput!]!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## IngestDropshipSnapshotInput

| Field | Type | Description |
| --- | --- | --- |
| `feedId` | `String!` |  |
| `inventoryOwnerKey` | `String` |  |
| `lines` | `[DropshipInventoryLineInput!]!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## InspectReturnInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `inspectionNotes` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `returnId` | `ID!` |  |
| `tenantId` | `String!` |  |

## InstallOnboardingAgentInput

| Field | Type | Description |
| --- | --- | --- |
| `agentDefinitionId` | `String!` |  |
| `capabilityGrant` | `JSON` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `mode` | `String` |  |
| `tenantId` | `String!` |  |

## InventoryCommandJsonInput

Inventory command envelope. Put command-specific fields in `payload`; `tenantId` and `metadata` are bound by the GraphQL command guard.

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `payload` | `JSON` |  |
| `tenantId` | `String!` |  |

## LabelShipmentInput

| Field | Type | Description |
| --- | --- | --- |
| `carrier` | `String!` |  |
| `carrierPartyId` | `ID` |  |
| `expectedDeliveryOn` | `DateTime` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `packageCount` | `Int` |  |
| `serviceLevel` | `String!` |  |
| `shipmentId` | `ID!` |  |
| `tenantId` | `String!` |  |
| `trackingRef` | `String!` |  |
| `trackingUrl` | `String` |  |
| `weightGrams` | `Int` |  |

## LocationOperatingHoursEntryInput

| Field | Type | Description |
| --- | --- | --- |
| `closesAt` | `String!` |  |
| `dayOfWeek` | `Int!` |  |
| `effectiveFrom` | `String` |  |
| `effectiveTo` | `String` |  |
| `isClosed` | `Boolean` |  |
| `opensAt` | `String!` |  |
| `shiftLabel` | `String` |  |

## MarkInventoryDamagedInput

| Field | Type | Description |
| --- | --- | --- |
| `evidenceUri` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `inventoryLevelId` | `ID!` |  |
| `inventoryLotId` | `ID` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `notes` | `String` |  |
| `quantity` | `Float!` |  |
| `reasonCode` | `String` | Accepted values: DAMAGE, QC_FAIL, EXPIRY, OPERATOR_OVERRIDE. Defaults to DAMAGE. |
| `tenantId` | `String!` |  |

## MarkReturnInTransitInput

| Field | Type | Description |
| --- | --- | --- |
| `carrierRef` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `returnId` | `ID!` |  |
| `tenantId` | `String!` |  |
| `trackingRef` | `String` |  |

## MuteAnalyticsAlertInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `muteUntil` | `String` |  |
| `ruleKey` | `String!` |  |
| `scope` | `AnalyticsAlertScope!` |  |
| `tenantId` | `String!` |  |

## PauseJobScheduleInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String` |  |
| `scheduleId` | `ID!` |  |
| `tenantId` | `String!` |  |

## PauseWebhookSubscriptionInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |
| `webhookSubscriptionId` | `ID!` |  |

## PreviewProgressiveActionInput

| Field | Type | Description |
| --- | --- | --- |
| `actionId` | `ID!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `note` | `String` |  |
| `previewResult` | `JSON!` |  |
| `tenantId` | `String!` |  |

## ProcessGdprDataRequestInput

| Field | Type | Description |
| --- | --- | --- |
| `bindingId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `partnerCustomerEmail` | `String` |  |
| `partnerCustomerId` | `String!` |  |
| `partnerOrdersRequested` | `[String!]` |  |
| `receivedOn` | `DateTime!` |  |
| `tenantId` | `String!` |  |

## PromoteTenantConfigInput

| Field | Type | Description |
| --- | --- | --- |
| `configKeys` | `[String!]` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `sourceEnvironmentId` | `String!` |  |
| `targetEnvironmentId` | `String!` |  |
| `tenantId` | `String!` |  |

## ProposeCustomerServiceActionInput

| Field | Type | Description |
| --- | --- | --- |
| `actionFamily` | `String` |  |
| `approvalRequestId` | `ID` |  |
| `commandPlan` | `JSON` |  |
| `customerAnswer` | `String` |  |
| `evalScore` | `Float` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `modelId` | `String` |  |
| `policyDecision` | `String` |  |
| `progressiveActionId` | `ID` |  |
| `rationale` | `String` |  |
| `requestId` | `ID!` |  |
| `riskClass` | `String` |  |
| `tenantId` | `String!` |  |

## ProposeProgressiveActionInput

| Field | Type | Description |
| --- | --- | --- |
| `actionKind` | `String!` |  |
| `actionMetadata` | `JSON` |  |
| `commandType` | `String` |  |
| `correlationId` | `String` |  |
| `expiresAt` | `DateTime` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `moduleSlot` | `String!` |  |
| `proposalPayload` | `JSON` |  |
| `riskClass` | `String!` |  |
| `skillId` | `String` |  |
| `skipPreview` | `Boolean` |  |
| `tenantId` | `String!` |  |

## PublishChannelListingInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `listingId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## ReallocateReservationLotInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedReservationVersion` | `Int!` |  |
| `lotAllocationPolicyId` | `String` |  |
| `lotAllocationStrategy` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reservationId` | `ID!` |  |
| `tenantId` | `String!` |  |

## ReasonedProgressiveActionInput

| Field | Type | Description |
| --- | --- | --- |
| `actionId` | `ID!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String!` |  |
| `tenantId` | `String!` |  |

## RebuildChannelAvailabilityInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `scopeId` | `ID` |  |
| `scopeKind` | `String!` |  |
| `tenantId` | `String!` |  |

## RebuildLotsFromLedgerInput

| Field | Type | Description |
| --- | --- | --- |
| `inventoryLevelId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## ReceiveReturnInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `returnId` | `ID!` |  |
| `tenantId` | `String!` |  |

## ReceiveStockTransferInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedToInventoryLevelVersion` | `Int!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `receivedOn` | `DateTime!` |  |
| `receivedQuantity` | `Float!` |  |
| `stockTransferId` | `ID!` |  |
| `tenantId` | `String!` |  |

## RecomputeFutureAvailabilityInput

| Field | Type | Description |
| --- | --- | --- |
| `locationId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reasonCode` | `String` |  |
| `tenantId` | `String!` |  |
| `variantId` | `ID!` |  |

## RecordAhaMomentInput

| Field | Type | Description |
| --- | --- | --- |
| `evidenceCorrelationId` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `scenarioId` | `String!` |  |
| `tenantId` | `String!` |  |

## RecordAppUserSessionHeartbeatInput

| Field | Type | Description |
| --- | --- | --- |
| `appId` | `String` |  |
| `appInstallationId` | `String` |  |
| `appSurface` | `String!` |  |
| `browserName` | `String` |  |
| `deviceLabel` | `String` |  |
| `deviceType` | `String` |  |
| `ipHash` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `occurredOn` | `DateTime` |  |
| `osName` | `String` |  |
| `tenantId` | `String!` |  |
| `userAgent` | `String` |  |
| `webSessionId` | `String!` |  |

## RecordConnectorWebhookReceiptInput

| Field | Type | Description |
| --- | --- | --- |
| `bindingId` | `ID!` |  |
| `bodyHash` | `String!` |  |
| `connectorKey` | `String!` |  |
| `deliveryId` | `String!` |  |
| `externalAccountRef` | `String` |  |
| `hmacVerified` | `Boolean!` |  |
| `lastError` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `provider` | `String!` |  |
| `providerEventId` | `String` |  |
| `providerReference` | `String` |  |
| `rawPayloadRef` | `String` |  |
| `receivedOn` | `DateTime` |  |
| `replayFingerprint` | `String!` |  |
| `status` | `String!` |  |
| `tenantId` | `String!` |  |
| `topic` | `String!` |  |

## RecordCountLineInput

| Field | Type | Description |
| --- | --- | --- |
| `countSessionId` | `String!` |  |
| `countedById` | `String` |  |
| `countedByType` | `String` |  |
| `countedOn` | `DateTime!` |  |
| `countedQuantity` | `Int!` |  |
| `inventoryLevelId` | `String!` |  |
| `locationId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `quantityType` | `String!` |  |
| `tenantId` | `String!` |  |
| `toleranceClass` | `String` |  |
| `variantId` | `String!` |  |

## RecordFulfillmentOrderLinePackInput

| Field | Type | Description |
| --- | --- | --- |
| `evidenceRef` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `fulfillmentOrderId` | `ID!` |  |
| `fulfillmentOrderLineId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `packageRef` | `String` |  |
| `quantity` | `Int!` |  |
| `tenantId` | `String!` |  |

## RecordFulfillmentOrderLinePickInput

| Field | Type | Description |
| --- | --- | --- |
| `evidenceRef` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `fulfillmentOrderId` | `ID!` |  |
| `fulfillmentOrderLineId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `quantity` | `Int!` |  |
| `sourceBinId` | `ID` |  |
| `tenantId` | `String!` |  |

## RedactCustomerDataInput

| Field | Type | Description |
| --- | --- | --- |
| `bindingId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `partnerCustomerEmail` | `String` |  |
| `partnerCustomerId` | `String!` |  |
| `receivedOn` | `DateTime!` |  |
| `tenantId` | `String!` |  |

## RedactShopDataInput

| Field | Type | Description |
| --- | --- | --- |
| `bindingId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `operatorApprovalReceiptId` | `ID!` |  |
| `partnerShopId` | `String!` |  |
| `receivedOn` | `DateTime!` |  |
| `shopDomain` | `String!` |  |
| `tenantId` | `String!` |  |

## RegisterFutureSupplyInput

| Field | Type | Description |
| --- | --- | --- |
| `confidenceScore` | `Float` |  |
| `expectedOn` | `DateTime!` |  |
| `initialStatus` | `String` |  |
| `inventoryLevelId` | `ID!` |  |
| `inventoryLotId` | `ID` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `quantity` | `Float!` |  |
| `reasonCode` | `String` |  |
| `sourceId` | `String!` |  |
| `sourceType` | `String!` |  |
| `tenantId` | `String!` |  |

## RejectReturnInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `rejectionReason` | `String!` |  |
| `returnId` | `ID!` |  |
| `tenantId` | `String!` |  |

## ReleaseBundleReservationInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reasonCode` | `String` |  |
| `reservationGroupId` | `ID!` |  |
| `tenantId` | `String!` |  |

## ReleaseReservationInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedReservationVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reasonCode` | `String` |  |
| `reservationId` | `ID!` |  |
| `tenantId` | `String!` |  |

## RemoveSubstituteMemberInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `memberId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reasonCode` | `String` |  |
| `tenantId` | `String!` |  |

## ReplayWebhookDeliveryInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `resetAttempts` | `Boolean` |  |
| `tenantId` | `String!` |  |
| `webhookDeliveryId` | `ID!` |  |

## RequestAnalyticsExportInput

Tenant request for an analytical extract. Slice 8 only ships PARQUET; CSV is refused at the handler. The reportDef object is the analyticsExportRequest envelope (surface, reportId, filters, reason).

| Field | Type | Description |
| --- | --- | --- |
| `bucketRange` | `AnalyticsExportBucketRangeInput!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reportDef` | `JSON!` |  |
| `tenantId` | `String!` |  |

## RequestApprovalInput

| Field | Type | Description |
| --- | --- | --- |
| `dueOn` | `DateTime` |  |
| `entityId` | `String!` |  |
| `entityType` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `requestedAction` | `String!` |  |
| `requestedReason` | `String` |  |
| `tenantId` | `String!` |  |

## ReserveBundleInput

| Field | Type | Description |
| --- | --- | --- |
| `bundleId` | `ID!` |  |
| `cartId` | `ID` |  |
| `componentReservations` | `[ComponentReservationInput!]!` |  |
| `expiresOn` | `DateTime` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `orderId` | `ID` |  |
| `reasonCode` | `String` |  |
| `reservationGroupId` | `ID` |  |
| `reservationType` | `String!` |  |
| `tenantId` | `String!` |  |

## ResetOnboardingInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String!` |  |
| `tenantId` | `String!` |  |

## ResolveApprovalInput

| Field | Type | Description |
| --- | --- | --- |
| `approvalRequestId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `resolution` | `String!` |  |
| `resolutionReason` | `String` |  |
| `tenantId` | `String!` |  |

## ResolveCustomerServiceRequestInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `requestId` | `ID!` |  |
| `resolutionSummary` | `String!` |  |
| `resolvedCommandReceiptId` | `ID` |  |
| `tenantId` | `String!` |  |

## ResolveExternalTaskInput

| Field | Type | Description |
| --- | --- | --- |
| `externalTaskId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `outputPayload` | `JSON` |  |
| `resolution` | `String!` |  |
| `tenantId` | `String!` |  |

## ResolveReconciliationDifferenceInput

| Field | Type | Description |
| --- | --- | --- |
| `decisionReason` | `String!` |  |
| `decisionType` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reconciliationDifferenceId` | `ID!` |  |
| `tenantId` | `String!` |  |

## ResolveReturnInput

| Field | Type | Description |
| --- | --- | --- |
| `currency` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `refundMinor` | `Int` |  |
| `resolution` | `String!` | REFUND \| REPLACEMENT \| STORE_CREDIT \| REPAIR \| DISCARD \| RESTOCK |
| `returnId` | `ID!` |  |
| `tenantId` | `String!` |  |

## RestoreInventoryFromDamagedInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `inventoryLevelId` | `ID!` |  |
| `inventoryLotId` | `ID` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `notes` | `String` |  |
| `quantity` | `Float!` |  |
| `reasonCode` | `String` | Accepted values: REPAIR_COMPLETED, INSPECTION_CLEARED, OPERATOR_OVERRIDE. Defaults to REPAIR_COMPLETED. |
| `tenantId` | `String!` |  |

## ResumeJobScheduleInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `nextRunOn` | `DateTime` |  |
| `reason` | `String` |  |
| `scheduleId` | `ID!` |  |
| `tenantId` | `String!` |  |

## ResumeWebhookSubscriptionInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |
| `webhookSubscriptionId` | `ID!` |  |

## RetireBusinessUnitInput

| Field | Type | Description |
| --- | --- | --- |
| `businessUnitId` | `ID!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## RetireChannelAssignmentInput

| Field | Type | Description |
| --- | --- | --- |
| `assignmentId` | `ID!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## RetireCommerceMarketInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `marketId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## RetireSubstituteGroupInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `groupId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reasonCode` | `String` |  |
| `tenantId` | `String!` |  |

## RotateShopifyTokenInput

| Field | Type | Description |
| --- | --- | --- |
| `accessTokenSecretRef` | `String!` |  |
| `bindingId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `rotatedByActorId` | `String!` |  |
| `scope` | `[String!]` |  |
| `tenantId` | `String!` |  |

## RotateWebhookSubscriptionSecretInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |
| `webhookSubscriptionId` | `ID!` |  |

## SaveAnalyticsReportDefinitionInput

| Field | Type | Description |
| --- | --- | --- |
| `displayName` | `String!` |  |
| `environmentId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reportKey` | `String!` |  |
| `request` | `JSON!` |  |
| `tenantId` | `String!` |  |

## SeedSampleInventoryInput

| Field | Type | Description |
| --- | --- | --- |
| `dryRun` | `Boolean` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `scenarioId` | `String!` |  |
| `tenantId` | `String!` |  |

## SendAdminBroadcastInput

| Field | Type | Description |
| --- | --- | --- |
| `actionLabel` | `String` |  |
| `actionPayload` | `JSON` |  |
| `actionRouteRef` | `String` |  |
| `actionUrl` | `String` |  |
| `body` | `String!` |  |
| `expiresOn` | `DateTime` |  |
| `feedBadgeLabel` | `String` |  |
| `feedBadgeTone` | `String` |  |
| `feedCategory` | `String` |  |
| `feedMetadata` | `JSON` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `severity` | `String` |  |
| `sourceAppInstallationId` | `String` |  |
| `sourceEventId` | `String` |  |
| `targetAppInstallationId` | `String` |  |
| `targetRole` | `String` |  |
| `targetScope` | `String` |  |
| `targetUserId` | `String` |  |
| `tenantId` | `String!` |  |
| `title` | `String!` |  |
| `triggerEntityId` | `String` |  |
| `triggerEntityType` | `String` |  |
| `triggerEventType` | `String` |  |

## SetOnboardingPersonaInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `persona` | `String!` |  |
| `tenantId` | `String!` |  |

## ShipStockTransferInput

| Field | Type | Description |
| --- | --- | --- |
| `carrier` | `String` |  |
| `expectedFromInventoryLevelVersion` | `Int!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `shippedOn` | `DateTime!` |  |
| `stockTransferId` | `ID!` |  |
| `tenantId` | `String!` |  |
| `trackingRef` | `String` |  |

## SkipOnboardingStepInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `nextStepId` | `String!` |  |
| `reason` | `String!` |  |
| `stepId` | `String!` |  |
| `tenantId` | `String!` |  |

## StartCountSessionInput

| Field | Type | Description |
| --- | --- | --- |
| `countedOn` | `DateTime` |  |
| `locationId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `sessionType` | `String!` |  |
| `sourceRef` | `String` |  |
| `sourceSystem` | `String` |  |
| `tenantId` | `String!` |  |

## StartFulfillmentOrderPickingInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `fulfillmentOrderId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## StartOnboardingInput

| Field | Type | Description |
| --- | --- | --- |
| `metadata` | `CommandMetadataInput!` |  |
| `source` | `String` |  |
| `tenantId` | `String!` |  |

## SuppressChannelListingInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `listingId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `suppressedReason` | `String!` |  |
| `tenantId` | `String!` |  |

## TenantDeploymentInput

| Field | Type | Description |
| --- | --- | --- |
| `archiveStorageRef` | `String` |  |
| `auditLogRef` | `String` |  |
| `backupPolicyRef` | `String` |  |
| `cellId` | `String` |  |
| `databaseRef` | `String!` |  |
| `deploymentId` | `String` |  |
| `deploymentKey` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `indexRef` | `String` |  |
| `isolationMode` | `String!` |  |
| `kmsKeyRef` | `String` |  |
| `lifecycleStage` | `String` |  |
| `logSinkRef` | `String` |  |
| `migrationState` | `JSON` |  |
| `objectStoragePrefix` | `String` |  |
| `objectStorageRef` | `String` |  |
| `queueLaneRef` | `String` |  |
| `readReplicaRef` | `String` |  |
| `region` | `String!` |  |
| `routingMetadata` | `JSON` |  |
| `schemaRef` | `String` |  |
| `secretsRef` | `String` |  |
| `status` | `String` |  |
| `storageMode` | `String!` |  |
| `workerPoolRef` | `String` |  |

## UninstallShopifyConnectorInput

| Field | Type | Description |
| --- | --- | --- |
| `bindingId` | `ID!` |  |
| `detail` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `reason` | `String!` |  |
| `tenantId` | `String!` |  |

## UpdateAnalyticsAlertInput

| Field | Type | Description |
| --- | --- | --- |
| `channels` | `[String!]` |  |
| `description` | `String` |  |
| `displayName` | `String!` |  |
| `escalationAfterHours` | `Int` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `muteUntil` | `String` |  |
| `ruleKey` | `String!` |  |
| `scope` | `AnalyticsAlertScope!` |  |
| `severity` | `String!` |  |
| `spec` | `JSON!` |  |
| `status` | `String` |  |
| `tenantId` | `String!` |  |

## UpdateDropshipFeedInput

| Field | Type | Description |
| --- | --- | --- |
| `connectorKey` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `feedId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `scheduleCron` | `String` |  |
| `stalenessThresholdSeconds` | `Int` |  |
| `status` | `String` |  |
| `tenantId` | `String!` |  |

## UpdateFutureSupplyInput

| Field | Type | Description |
| --- | --- | --- |
| `confidenceScore` | `Float` |  |
| `expectedOn` | `DateTime` |  |
| `expectedVersion` | `Int!` |  |
| `futureQuantityId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `quantity` | `Float` |  |
| `reasonCode` | `String` |  |
| `tenantId` | `String!` |  |

## UpdateLocationInput

| Field | Type | Description |
| --- | --- | --- |
| `addressLine1` | `String` |  |
| `addressLine2` | `String` |  |
| `alcoholLicensed` | `Boolean` |  |
| `capacityPallets` | `Int` |  |
| `capacitySqFt` | `Int` |  |
| `capacityUnits` | `Int` |  |
| `city` | `String` |  |
| `closedOn` | `String` |  |
| `coldChain` | `Boolean` |  |
| `contactPartyId` | `String` |  |
| `country` | `String` |  |
| `crossDockCapable` | `Boolean` |  |
| `email` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `handlingCutoffLocalTime` | `String` |  |
| `hazmatCertified` | `Boolean` |  |
| `isReturnDestination` | `Boolean` |  |
| `isTransferDestination` | `Boolean` |  |
| `latitude` | `Float` |  |
| `locationId` | `ID!` |  |
| `locationRef` | `String` |  |
| `locationType` | `String` |  |
| `longitude` | `Float` |  |
| `lotTrackingEnabled` | `Boolean` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `name` | `String` |  |
| `openedOn` | `String` |  |
| `parentLocationId` | `String` |  |
| `phone` | `String` |  |
| `pickupEnabled` | `Boolean` |  |
| `postalCode` | `String` |  |
| `regionCode` | `String` |  |
| `serialTrackingEnabled` | `Boolean` |  |
| `serviceEnabled` | `Boolean` |  |
| `shipFromStoreEnabled` | `Boolean` |  |
| `state` | `String` |  |
| `taxJurisdictionRef` | `String` |  |
| `temperatureControlled` | `Boolean` |  |
| `tenantId` | `String!` |  |
| `timeZone` | `String` |  |
| `trustLevel` | `String` |  |

## UpdateProductInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `name` | `String` |  |
| `productId` | `ID!` |  |
| `productRef` | `String` |  |
| `tenantId` | `String!` |  |

## UpdateProductVariantInput

| Field | Type | Description |
| --- | --- | --- |
| `barcode` | `String` |  |
| `defaultShelfLifeDays` | `Int` |  |
| `expectedVersion` | `Int!` |  |
| `exportControlClass` | `String` |  |
| `hazmatClass` | `String` |  |
| `hsCode` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `optionValues` | `JSON` |  |
| `requiresExpiryTracking` | `Boolean` |  |
| `requiresLotTracking` | `Boolean` |  |
| `requiresSerialTracking` | `Boolean` |  |
| `sku` | `String` |  |
| `temperatureZone` | `String` |  |
| `tenantId` | `String!` |  |
| `trackingType` | `String` |  |
| `uom` | `String` |  |
| `variantId` | `ID!` |  |

## UpsertBusinessUnitInput

| Field | Type | Description |
| --- | --- | --- |
| `description` | `String` |  |
| `displayName` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `parentBuId` | `ID` |  |
| `status` | `String` |  |
| `tenantId` | `String!` |  |
| `unitKey` | `String!` |  |

## UpsertChannelAssignmentInput

| Field | Type | Description |
| --- | --- | --- |
| `assignmentKey` | `String!` |  |
| `businessUnitId` | `ID` |  |
| `channelExposureStrategyId` | `ID` |  |
| `commerceMarketId` | `ID` |  |
| `eligibilityProfileId` | `ID` |  |
| `expectedVersion` | `Int!` |  |
| `fulfillmentNetworkId` | `ID` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `priority` | `Int` |  |
| `salesChannelId` | `ID` |  |
| `scopeKind` | `String!` |  |
| `sourcingProfileId` | `ID` |  |
| `status` | `String` |  |
| `tenantId` | `String!` |  |
| `validFrom` | `String` |  |
| `validTo` | `String` |  |

## UpsertChannelListingInput

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `String!` |  |
| `description` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `externalListingId` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `productId` | `String!` |  |
| `tenantId` | `String!` |  |
| `title` | `String` |  |
| `variantId` | `String!` |  |

## UpsertChannelOfferInput

| Field | Type | Description |
| --- | --- | --- |
| `compareAtPriceMinor` | `Int` |  |
| `currency` | `String!` |  |
| `effectiveFrom` | `String!` |  |
| `effectiveTo` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `listingId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `offerId` | `ID` |  |
| `priceListId` | `ID` |  |
| `priceMinor` | `Int!` |  |
| `tenantId` | `String!` |  |

## UpsertCommerceMarketInput

| Field | Type | Description |
| --- | --- | --- |
| `countryCodes` | `[String!]` |  |
| `defaultCurrency` | `String!` |  |
| `description` | `String` |  |
| `displayName` | `String!` |  |
| `expectedVersion` | `Int!` |  |
| `localeCodes` | `[String!]` |  |
| `marketKey` | `String!` |  |
| `marketType` | `String!` |  |
| `marketplaceRef` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `regionCode` | `String` |  |
| `status` | `String` |  |
| `taxJurisdictionRef` | `String` |  |
| `tenantId` | `String!` |  |

## UpsertCustomFieldInput

| Field | Type | Description |
| --- | --- | --- |
| `booleanValue` | `Boolean` |  |
| `dateValue` | `String` |  |
| `entityId` | `String!` |  |
| `entityType` | `String!` |  |
| `expectedVersion` | `Int` |  |
| `fieldGroup` | `String` |  |
| `isIndexed` | `Boolean` |  |
| `jsonValue` | `JSON` |  |
| `key` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `namespace` | `String!` |  |
| `numberValue` | `Float` |  |
| `sourceSystem` | `String` |  |
| `stringValue` | `String` |  |
| `tenantId` | `String!` |  |
| `valueType` | `String!` |  |

## UpsertJobScheduleInput

| Field | Type | Description |
| --- | --- | --- |
| `jobType` | `String!` |  |
| `maxAttempts` | `Int` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `nextRunOn` | `DateTime!` |  |
| `payloadTemplate` | `JSON` |  |
| `scheduleConfig` | `JSON!` |  |
| `scheduleId` | `ID` |  |
| `scheduleKey` | `String!` |  |
| `scheduleType` | `String!` |  |
| `status` | `String` |  |
| `statusReason` | `String` |  |
| `tenantId` | `String!` |  |

## UpsertLocationOperatingExceptionInput

| Field | Type | Description |
| --- | --- | --- |
| `closesAt` | `String` |  |
| `exceptionDate` | `String!` |  |
| `isClosed` | `Boolean` |  |
| `locationId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `opensAt` | `String` |  |
| `reason` | `String` |  |
| `tenantId` | `String!` |  |

## UpsertLocationOperatingHoursInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `hours` | `[LocationOperatingHoursEntryInput!]!` |  |
| `locationId` | `ID!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |

## UpsertSubstituteGroupInput

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `String` |  |
| `description` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `groupKey` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `primaryVariantId` | `String!` |  |
| `priority` | `Int` |  |
| `status` | `String` |  |
| `tenantId` | `String!` |  |
| `validFrom` | `String` |  |
| `validTo` | `String` |  |

## UpsertSubstituteMemberInput

| Field | Type | Description |
| --- | --- | --- |
| `expectedVersion` | `Int!` |  |
| `groupId` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `priority` | `Int` |  |
| `status` | `String` |  |
| `substituteFactor` | `Float!` |  |
| `substituteVariantId` | `String!` |  |
| `tenantId` | `String!` |  |

## UpsertTenantConfigInput

| Field | Type | Description |
| --- | --- | --- |
| `configKey` | `String!` |  |
| `description` | `String` |  |
| `expectedVersion` | `Int!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `tenantId` | `String!` |  |
| `value` | `JSON!` |  |

## UpsertTenantEnvironmentInput

| Field | Type | Description |
| --- | --- | --- |
| `dataClassification` | `String` |  |
| `deletionPolicyRef` | `String` |  |
| `deployment` | `TenantDeploymentInput` |  |
| `environmentId` | `String!` |  |
| `environmentKey` | `String` |  |
| `environmentMetadata` | `JSON` |  |
| `environmentType` | `String!` |  |
| `expectedEnvironmentVersion` | `Int!` |  |
| `lifecycleStage` | `String` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `name` | `String` |  |
| `promotionPolicyRef` | `String` |  |
| `retentionPolicyRef` | `String` |  |
| `sourceEnvironmentId` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String!` |  |

## UpsertWebhookSubscriptionInput

| Field | Type | Description |
| --- | --- | --- |
| `deliveryMode` | `String!` |  |
| `eventPattern` | `String!` |  |
| `metadata` | `CommandMetadataInput!` |  |
| `signingSecretRef` | `String!` |  |
| `status` | `String` |  |
| `targetUrl` | `String!` |  |
| `tenantId` | `String!` |  |
| `webhookSubscriptionId` | `ID` |  |

---

## GraphQL mutations

URL: https://www.karmanflow.com/developers/reference/graphql/mutations
Summary: Command entry points exposed by the KarmanFlow GraphQL API.

# GraphQL mutations

Command entry points exposed by the KarmanFlow GraphQL API.

## acknowledgeAdminBroadcastDelivery

acknowledgeAdminBroadcastDelivery(input: AppFeedItemStateInput!): AppFeedItemStatePayload

**Arguments**

- `input: AppFeedItemStateInput!`: (no description)

## acknowledgeIncident

acknowledgeIncident(input: AcknowledgeIncidentInput!): AcknowledgeIncidentResult

**Arguments**

- `input: AcknowledgeIncidentInput!`: (no description)

## activateAsShopifyFulfillmentService

activateAsShopifyFulfillmentService(input: ActivateAsShopifyFulfillmentServiceInput!): ConnectorCommandPayload

**Arguments**

- `input: ActivateAsShopifyFulfillmentServiceInput!`: (no description)

## addShopifyShop

addShopifyShop(input: AddShopifyShopInput!): ConnectorCommandPayload

**Arguments**

- `input: AddShopifyShopInput!`: (no description)

## adjustInventory

adjustInventory(input: AdjustInventoryInput!): AdjustInventoryPayload

**Arguments**

- `input: AdjustInventoryInput!`: (no description)

## advanceOnboardingStep

advanceOnboardingStep(input: AdvanceOnboardingStepInput!): OnboardingProgressView

**Arguments**

- `input: AdvanceOnboardingStepInput!`: (no description)

## allocateFulfillmentOrder

allocateFulfillmentOrder(input: AllocateFulfillmentOrderInput!): FulfillmentOrderStatusPayload

**Arguments**

- `input: AllocateFulfillmentOrderInput!`: (no description)

## applyCountVariance

applyCountVariance(input: ApplyCountVarianceInput!): ApplyCountVariancePayload

**Arguments**

- `input: ApplyCountVarianceInput!`: (no description)

## approveProgressiveAction

approveProgressiveAction(input: ApproveProgressiveActionInput!): ProgressiveActionCommandPayload

**Arguments**

- `input: ApproveProgressiveActionInput!`: (no description)

## assignPartyRole

assignPartyRole(input: AssignPartyRoleInput!): AssignPartyRolePayload

**Arguments**

- `input: AssignPartyRoleInput!`: (no description)

## assignPartyToTier

Assign an identity party to a customer tier for B2B account allocation.

assignPartyToTier(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## authorizeReturn

authorizeReturn(input: AuthorizeReturnInput!): ReturnStatusPayload

**Arguments**

- `input: AuthorizeReturnInput!`: (no description)

## buildCustomerServiceContext

buildCustomerServiceContext(input: BuildCustomerServiceContextInput!): CustomerServiceCommandPayload

**Arguments**

- `input: BuildCustomerServiceContextInput!`: (no description)

## cancelAnalyticsExport

Cancel a tenant export while it is still REQUESTED. Refuses RUNNING and terminal rows.

cancelAnalyticsExport(input: CancelAnalyticsExportInput!): AnalyticsExportMutationResult

**Arguments**

- `input: CancelAnalyticsExportInput!`: (no description)

## cancelFulfillmentOrder

cancelFulfillmentOrder(input: CancelFulfillmentOrderInput!): CancelFulfillmentOrderPayload

**Arguments**

- `input: CancelFulfillmentOrderInput!`: (no description)

## cancelFutureSupply

Mark a future-quantity row CANCELLED. No-op against terminal rows.

cancelFutureSupply(input: CancelFutureSupplyInput!): FutureSupplyMutationResult

**Arguments**

- `input: CancelFutureSupplyInput!`: (no description)

## cancelJobSchedule

cancelJobSchedule(input: CancelJobScheduleInput!): JobScheduleStatusPayload

**Arguments**

- `input: CancelJobScheduleInput!`: (no description)

## cancelProgressiveAction

cancelProgressiveAction(input: ReasonedProgressiveActionInput!): ProgressiveActionCommandPayload

**Arguments**

- `input: ReasonedProgressiveActionInput!`: (no description)

## cancelReturn

cancelReturn(input: CancelReturnInput!): CancelReturnPayload

**Arguments**

- `input: CancelReturnInput!`: (no description)

## cancelStockTransfer

cancelStockTransfer(input: CancelStockTransferInput!): CancelStockTransferPayload

**Arguments**

- `input: CancelStockTransferInput!`: (no description)

## cleanupSampleData

cleanupSampleData(input: CleanupSampleDataInput!): CleanupSampleDataResult

**Arguments**

- `input: CleanupSampleDataInput!`: (no description)

## clearSampleData

clearSampleData(input: ClearSampleDataInput!): ClearSampleDataResult

**Arguments**

- `input: ClearSampleDataInput!`: (no description)

## closeCountSession

closeCountSession(input: CloseCountSessionInput!): CloseCountSessionPayload

**Arguments**

- `input: CloseCountSessionInput!`: (no description)

## commitBundleReservation

commitBundleReservation(input: CommitBundleReservationInput!): CommitBundleReservationResult

**Arguments**

- `input: CommitBundleReservationInput!`: (no description)

## commitReservation

commitReservation(input: CommitReservationInput!): CommitReservationPayload

**Arguments**

- `input: CommitReservationInput!`: (no description)

## completeFulfillmentOrderPacking

completeFulfillmentOrderPacking(input: CompleteFulfillmentOrderPackingInput!): FulfillmentOrderStatusPayload

**Arguments**

- `input: CompleteFulfillmentOrderPackingInput!`: (no description)

## configureTenantDefaults

configureTenantDefaults(input: ConfigureTenantDefaultsInput!): ConfigureTenantDefaultsResult

**Arguments**

- `input: ConfigureTenantDefaultsInput!`: (no description)

## createAddress

createAddress(input: CreateAddressInput!): CreateAddressPayload

**Arguments**

- `input: CreateAddressInput!`: (no description)

## createAnalyticsAlert

createAnalyticsAlert(input: CreateAnalyticsAlertInput!): AnalyticsAlertResult

**Arguments**

- `input: CreateAnalyticsAlertInput!`: (no description)

## createContactPoint

createContactPoint(input: CreateContactPointInput!): CreateContactPointPayload

**Arguments**

- `input: CreateContactPointInput!`: (no description)

## createCustomerServiceRequest

createCustomerServiceRequest(input: CreateCustomerServiceRequestInput!): CustomerServiceCommandPayload

**Arguments**

- `input: CreateCustomerServiceRequestInput!`: (no description)

## createDropshipLocation

createDropshipLocation(input: CreateDropshipLocationInput!): CreateDropshipLocationPayload

**Arguments**

- `input: CreateDropshipLocationInput!`: (no description)

## createExternalTask

createExternalTask(input: CreateExternalTaskInput!): CreateExternalTaskPayload

**Arguments**

- `input: CreateExternalTaskInput!`: (no description)

## createFulfillmentOrder

createFulfillmentOrder(input: CreateFulfillmentOrderInput!): CreateFulfillmentOrderPayload

**Arguments**

- `input: CreateFulfillmentOrderInput!`: (no description)

## createOrder

createOrder(input: CreateOrderInput!): CreateOrderPayload

**Arguments**

- `input: CreateOrderInput!`: (no description)

## createParty

createParty(input: CreatePartyInput!): CreatePartyPayload

**Arguments**

- `input: CreatePartyInput!`: (no description)

## createProduct

createProduct(input: CreateProductInput!): CreateProductResult

**Arguments**

- `input: CreateProductInput!`: (no description)

## createProductVariant

createProductVariant(input: CreateProductVariantInput!): CreateProductVariantResult

**Arguments**

- `input: CreateProductVariantInput!`: (no description)

## createReservation

createReservation(input: CreateReservationInput!): CreateReservationPayload

**Arguments**

- `input: CreateReservationInput!`: (no description)

## createReturn

createReturn(input: CreateReturnInput!): CreateReturnPayload

**Arguments**

- `input: CreateReturnInput!`: (no description)

## createShipment

createShipment(input: CreateShipmentInput!): CreateShipmentPayload

**Arguments**

- `input: CreateShipmentInput!`: (no description)

## createStockTransfer

createStockTransfer(input: CreateStockTransferInput!): CreateStockTransferPayload

**Arguments**

- `input: CreateStockTransferInput!`: (no description)

## deactivateAsShopifyFulfillmentService

deactivateAsShopifyFulfillmentService(input: DeactivateAsShopifyFulfillmentServiceInput!): ConnectorCommandPayload

**Arguments**

- `input: DeactivateAsShopifyFulfillmentServiceInput!`: (no description)

## deactivateChannelOffer

deactivateChannelOffer(input: DeactivateChannelOfferInput!): DeactivateChannelOfferPayload

**Arguments**

- `input: DeactivateChannelOfferInput!`: (no description)

## declineProgressiveAction

declineProgressiveAction(input: ReasonedProgressiveActionInput!): ProgressiveActionCommandPayload

**Arguments**

- `input: ReasonedProgressiveActionInput!`: (no description)

## decommissionLocation

decommissionLocation(input: DecommissionLocationInput!): DecommissionLocationPayload

**Arguments**

- `input: DecommissionLocationInput!`: (no description)

## deleteAnalyticsAlert

deleteAnalyticsAlert(input: DeleteAnalyticsAlertInput!): AnalyticsAlertResult

**Arguments**

- `input: DeleteAnalyticsAlertInput!`: (no description)

## deleteSavedReport

deleteSavedReport(input: DeleteSavedReportInput!): DeleteSavedReportResult

**Arguments**

- `input: DeleteSavedReportInput!`: (no description)

## deleteSourcingCondition

Delete a sourcing strategy condition.

deleteSourcingCondition(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## deleteSourcingCriterion

Delete a sourcing strategy scoring criterion.

deleteSourcingCriterion(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## delistChannelListing

delistChannelListing(input: DelistChannelListingInput!): DelistChannelListingPayload

**Arguments**

- `input: DelistChannelListingInput!`: (no description)

## dismissAdminBroadcastDelivery

dismissAdminBroadcastDelivery(input: AppFeedItemStateInput!): AppFeedItemStatePayload

**Arguments**

- `input: AppFeedItemStateInput!`: (no description)

## dispatchShipment

dispatchShipment(input: DispatchShipmentInput!): DispatchShipmentPayload

**Arguments**

- `input: DispatchShipmentInput!`: (no description)

## eraseParty

eraseParty(input: ErasePartyInput!): ErasePartyPayload

**Arguments**

- `input: ErasePartyInput!`: (no description)

## escalateCustomerServiceRequest

escalateCustomerServiceRequest(input: EscalateCustomerServiceRequestInput!): CustomerServiceCommandPayload

**Arguments**

- `input: EscalateCustomerServiceRequestInput!`: (no description)

## escalateIncident

escalateIncident(input: EscalateIncidentInput!): EscalateIncidentResult

**Arguments**

- `input: EscalateIncidentInput!`: (no description)

## evaluateSourcing

Evaluate a sourcing profile against candidate fulfillment nodes without committing an order allocation.

evaluateSourcing(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## executeIncidentAction

executeIncidentAction(input: ExecuteIncidentActionInput!): ExecuteIncidentActionResult

**Arguments**

- `input: ExecuteIncidentActionInput!`: (no description)

## executeProgressiveAction

executeProgressiveAction(input: ExecuteProgressiveActionInput!): ProgressiveActionCommandPayload

**Arguments**

- `input: ExecuteProgressiveActionInput!`: (no description)

## expireReservation

expireReservation(input: ExpireReservationInput!): ExpireReservationPayload

**Arguments**

- `input: ExpireReservationInput!`: (no description)

## fireAhaMomentScenario

fireAhaMomentScenario(input: FireAhaMomentScenarioInput!): FireAhaMomentResult

**Arguments**

- `input: FireAhaMomentScenarioInput!`: (no description)

## fulfillFulfillmentOrder

fulfillFulfillmentOrder(input: FulfillFulfillmentOrderInput!): FulfillmentOrderStatusPayload

**Arguments**

- `input: FulfillFulfillmentOrderInput!`: (no description)

## ignoreShopifyDriftEvent

ignoreShopifyDriftEvent(input: IgnoreShopifyDriftEventInput!): ConnectorCommandPayload

**Arguments**

- `input: IgnoreShopifyDriftEventInput!`: (no description)

## ingestDropshipDelta

ingestDropshipDelta(input: IngestDropshipDeltaInput!): IngestDropshipDeltaPayload

**Arguments**

- `input: IngestDropshipDeltaInput!`: (no description)

## ingestDropshipSnapshot

ingestDropshipSnapshot(input: IngestDropshipSnapshotInput!): IngestDropshipSnapshotPayload

**Arguments**

- `input: IngestDropshipSnapshotInput!`: (no description)

## inspectReturn

inspectReturn(input: InspectReturnInput!): ReturnStatusPayload

**Arguments**

- `input: InspectReturnInput!`: (no description)

## installOnboardingAgent

installOnboardingAgent(input: InstallOnboardingAgentInput!): InstallOnboardingAgentResult

**Arguments**

- `input: InstallOnboardingAgentInput!`: (no description)

## labelShipment

labelShipment(input: LabelShipmentInput!): LabelShipmentPayload

**Arguments**

- `input: LabelShipmentInput!`: (no description)

## markAdminBroadcastDeliveryDelivered

markAdminBroadcastDeliveryDelivered(input: AppFeedItemStateInput!): AppFeedItemStatePayload

**Arguments**

- `input: AppFeedItemStateInput!`: (no description)

## markInventoryDamaged

markInventoryDamaged(input: MarkInventoryDamagedInput!): MarkInventoryDamagedPayload

**Arguments**

- `input: MarkInventoryDamagedInput!`: (no description)

## markReturnInTransit

markReturnInTransit(input: MarkReturnInTransitInput!): MarkReturnInTransitPayload

**Arguments**

- `input: MarkReturnInTransitInput!`: (no description)

## mintAnalyticsExportSignedUrl

Mint a short-lived signed download URL for a COMPLETED analytics export artifact. The URL is generated on demand and never persisted on the analytics_export row, the command receipt, or any event payload. The signedUrlId argument is the opaque handle written by the worker on completion.

mintAnalyticsExportSignedUrl(signedUrlId: ID!, tenantId: String!): AnalyticsExportSignedUrl

**Arguments**

- `signedUrlId: ID!`: (no description)
- `tenantId: String!`: (no description)

## muteAnalyticsAlert

muteAnalyticsAlert(input: MuteAnalyticsAlertInput!): MuteAnalyticsAlertResult

**Arguments**

- `input: MuteAnalyticsAlertInput!`: (no description)

## pauseAllocationPool

Pause an account allocation pool without retiring its history.

pauseAllocationPool(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## pauseJobSchedule

pauseJobSchedule(input: PauseJobScheduleInput!): JobScheduleStatusPayload

**Arguments**

- `input: PauseJobScheduleInput!`: (no description)

## pauseWebhookSubscription

pauseWebhookSubscription(input: PauseWebhookSubscriptionInput!): PauseWebhookSubscriptionPayload

**Arguments**

- `input: PauseWebhookSubscriptionInput!`: (no description)

## previewProgressiveAction

previewProgressiveAction(input: PreviewProgressiveActionInput!): ProgressiveActionCommandPayload

**Arguments**

- `input: PreviewProgressiveActionInput!`: (no description)

## previewSourcingOptimization

Preview a stored or caller-supplied sourcing optimization simulation.

previewSourcingOptimization(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## processGdprDataRequest

processGdprDataRequest(input: ProcessGdprDataRequestInput!): ConnectorCommandPayload

**Arguments**

- `input: ProcessGdprDataRequestInput!`: (no description)

## promoteTenantConfig

promoteTenantConfig(input: PromoteTenantConfigInput!): PromoteTenantConfigPayload

**Arguments**

- `input: PromoteTenantConfigInput!`: (no description)

## proposeCustomerServiceAction

proposeCustomerServiceAction(input: ProposeCustomerServiceActionInput!): CustomerServiceCommandPayload

**Arguments**

- `input: ProposeCustomerServiceActionInput!`: (no description)

## proposeProgressiveAction

proposeProgressiveAction(input: ProposeProgressiveActionInput!): ProgressiveActionCommandPayload

**Arguments**

- `input: ProposeProgressiveActionInput!`: (no description)

## proposeSourcingOptimization

Record a simulated sourcing optimization proposal without mutating live sourcing profiles.

proposeSourcingOptimization(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## publishChannelListing

publishChannelListing(input: PublishChannelListingInput!): PublishChannelListingPayload

**Arguments**

- `input: PublishChannelListingInput!`: (no description)

## reallocateReservationLot

reallocateReservationLot(input: ReallocateReservationLotInput!): ReallocateReservationLotPayload

**Arguments**

- `input: ReallocateReservationLotInput!`: (no description)

## rebuildChannelAvailability

rebuildChannelAvailability(input: RebuildChannelAvailabilityInput!): RebuildChannelAvailabilityPayload

**Arguments**

- `input: RebuildChannelAvailabilityInput!`: (no description)

## rebuildLotsFromLedger

rebuildLotsFromLedger(input: RebuildLotsFromLedgerInput!): RebuildLotsFromLedgerPayload

**Arguments**

- `input: RebuildLotsFromLedgerInput!`: (no description)

## receiveReturn

receiveReturn(input: ReceiveReturnInput!): ReturnStatusPayload

**Arguments**

- `input: ReceiveReturnInput!`: (no description)

## receiveStockTransfer

receiveStockTransfer(input: ReceiveStockTransferInput!): ReceiveStockTransferPayload

**Arguments**

- `input: ReceiveStockTransferInput!`: (no description)

## recomputeFutureAvailability

Operator backfill: enqueue a (variant, location) scope for the projector worker to rebuild from source aggregates. Approval-gated in production.

recomputeFutureAvailability(input: RecomputeFutureAvailabilityInput!): RecomputeFutureAvailabilityResult

**Arguments**

- `input: RecomputeFutureAvailabilityInput!`: (no description)

## recordAhaMoment

recordAhaMoment(input: RecordAhaMomentInput!): OnboardingProgressView

**Arguments**

- `input: RecordAhaMomentInput!`: (no description)

## recordAppUserSessionHeartbeat

recordAppUserSessionHeartbeat(input: RecordAppUserSessionHeartbeatInput!): RecordAppUserSessionHeartbeatPayload

**Arguments**

- `input: RecordAppUserSessionHeartbeatInput!`: (no description)

## recordConnectorWebhookReceipt

recordConnectorWebhookReceipt(input: RecordConnectorWebhookReceiptInput!): ConnectorCommandPayload

**Arguments**

- `input: RecordConnectorWebhookReceiptInput!`: (no description)

## recordCountLine

recordCountLine(input: RecordCountLineInput!): RecordCountLinePayload

**Arguments**

- `input: RecordCountLineInput!`: (no description)

## recordFulfillmentOrderLinePack

recordFulfillmentOrderLinePack(input: RecordFulfillmentOrderLinePackInput!): FulfillmentOrderLinePackPayload

**Arguments**

- `input: RecordFulfillmentOrderLinePackInput!`: (no description)

## recordFulfillmentOrderLinePick

recordFulfillmentOrderLinePick(input: RecordFulfillmentOrderLinePickInput!): FulfillmentOrderLinePickPayload

**Arguments**

- `input: RecordFulfillmentOrderLinePickInput!`: (no description)

## redactCustomerData

redactCustomerData(input: RedactCustomerDataInput!): ConnectorCommandPayload

**Arguments**

- `input: RedactCustomerDataInput!`: (no description)

## redactShopData

redactShopData(input: RedactShopDataInput!): ConnectorCommandPayload

**Arguments**

- `input: RedactShopDataInput!`: (no description)

## refillAllocationPool

Refill or top up reserved quantity on an account allocation pool.

refillAllocationPool(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## registerFutureSupply

Admin override that wraps the RegisterFutureSupply command. Use only for MANUAL source rows; side-effect side-effect-emitted rows (PO, inbound, transfer, plan) come through their owning source commands.

registerFutureSupply(input: RegisterFutureSupplyInput!): FutureSupplyMutationResult

**Arguments**

- `input: RegisterFutureSupplyInput!`: (no description)

## rejectReturn

rejectReturn(input: RejectReturnInput!): RejectReturnPayload

**Arguments**

- `input: RejectReturnInput!`: (no description)

## releaseBundleReservation

releaseBundleReservation(input: ReleaseBundleReservationInput!): ReleaseBundleReservationResult

**Arguments**

- `input: ReleaseBundleReservationInput!`: (no description)

## releaseReservation

releaseReservation(input: ReleaseReservationInput!): ReleaseReservationPayload

**Arguments**

- `input: ReleaseReservationInput!`: (no description)

## removeSubstituteMember

removeSubstituteMember(input: RemoveSubstituteMemberInput!): RemoveSubstituteMemberPayload

**Arguments**

- `input: RemoveSubstituteMemberInput!`: (no description)

## replayWebhookDelivery

replayWebhookDelivery(input: ReplayWebhookDeliveryInput!): ReplayWebhookDeliveryPayload

**Arguments**

- `input: ReplayWebhookDeliveryInput!`: (no description)

## requestAnalyticsExport

Create a tenant-scope analytics export. Wraps CreateAnalyticsExport at R2. Slice 8 only accepts PARQUET; CSV is refused at the handler.

requestAnalyticsExport(input: RequestAnalyticsExportInput!): AnalyticsExportMutationResult

**Arguments**

- `input: RequestAnalyticsExportInput!`: (no description)

## requestApproval

requestApproval(input: RequestApprovalInput!): RequestApprovalPayload

**Arguments**

- `input: RequestApprovalInput!`: (no description)

## reserveBundle

reserveBundle(input: ReserveBundleInput!): ReserveBundleResult

**Arguments**

- `input: ReserveBundleInput!`: (no description)

## resetOnboarding

resetOnboarding(input: ResetOnboardingInput!): ResetOnboardingResult

**Arguments**

- `input: ResetOnboardingInput!`: (no description)

## resolveApproval

resolveApproval(input: ResolveApprovalInput!): ResolveApprovalPayload

**Arguments**

- `input: ResolveApprovalInput!`: (no description)

## resolveCustomerServiceRequest

resolveCustomerServiceRequest(input: ResolveCustomerServiceRequestInput!): CustomerServiceCommandPayload

**Arguments**

- `input: ResolveCustomerServiceRequestInput!`: (no description)

## resolveExternalTask

resolveExternalTask(input: ResolveExternalTaskInput!): ResolveExternalTaskPayload

**Arguments**

- `input: ResolveExternalTaskInput!`: (no description)

## resolveReconciliationDifference

resolveReconciliationDifference(input: ResolveReconciliationDifferenceInput!): ResolveReconciliationDifferencePayload

**Arguments**

- `input: ResolveReconciliationDifferenceInput!`: (no description)

## resolveReturn

resolveReturn(input: ResolveReturnInput!): ResolveReturnPayload

**Arguments**

- `input: ResolveReturnInput!`: (no description)

## resolveSourcingOptimizationProposal

Approve, reject, or mark applied a sourcing optimization proposal.

resolveSourcingOptimizationProposal(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## resourceFulfillmentOrder

Re-source an existing fulfillment order and apply allocation deltas to inventory.

resourceFulfillmentOrder(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## restoreInventoryFromDamaged

restoreInventoryFromDamaged(input: RestoreInventoryFromDamagedInput!): RestoreInventoryFromDamagedPayload

**Arguments**

- `input: RestoreInventoryFromDamagedInput!`: (no description)

## resumeAllocationPool

Resume a paused account allocation pool.

resumeAllocationPool(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## resumeJobSchedule

resumeJobSchedule(input: ResumeJobScheduleInput!): JobScheduleStatusPayload

**Arguments**

- `input: ResumeJobScheduleInput!`: (no description)

## resumeWebhookSubscription

resumeWebhookSubscription(input: ResumeWebhookSubscriptionInput!): ResumeWebhookSubscriptionPayload

**Arguments**

- `input: ResumeWebhookSubscriptionInput!`: (no description)

## retireAllocationPool

Retire an account allocation pool after an expected-version check.

retireAllocationPool(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## retireBusinessUnit

retireBusinessUnit(input: RetireBusinessUnitInput!): RetireBusinessUnitPayload

**Arguments**

- `input: RetireBusinessUnitInput!`: (no description)

## retireChannelAssignment

retireChannelAssignment(input: RetireChannelAssignmentInput!): RetireChannelAssignmentPayload

**Arguments**

- `input: RetireChannelAssignmentInput!`: (no description)

## retireCommerceMarket

retireCommerceMarket(input: RetireCommerceMarketInput!): RetireCommerceMarketPayload

**Arguments**

- `input: RetireCommerceMarketInput!`: (no description)

## retireCustomerTier

Retire a customer tier so it no longer resolves for new allocation decisions.

retireCustomerTier(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## retireSourcingProfile

Retire a sourcing profile so it no longer participates in routing.

retireSourcingProfile(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## retireSourcingStrategy

Retire a sourcing strategy under a profile.

retireSourcingStrategy(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## retireSubstituteGroup

retireSubstituteGroup(input: RetireSubstituteGroupInput!): RetireSubstituteGroupPayload

**Arguments**

- `input: RetireSubstituteGroupInput!`: (no description)

## revokeTierMembership

Revoke a party's customer-tier membership.

revokeTierMembership(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## rotateShopifyToken

rotateShopifyToken(input: RotateShopifyTokenInput!): ConnectorCommandPayload

**Arguments**

- `input: RotateShopifyTokenInput!`: (no description)

## rotateWebhookSubscriptionSecret

rotateWebhookSubscriptionSecret(input: RotateWebhookSubscriptionSecretInput!): RotateWebhookSubscriptionSecretPayload

**Arguments**

- `input: RotateWebhookSubscriptionSecretInput!`: (no description)

## saveAnalyticsReportDefinition

saveAnalyticsReportDefinition(input: SaveAnalyticsReportDefinitionInput!): SaveAnalyticsReportDefinitionResult

**Arguments**

- `input: SaveAnalyticsReportDefinitionInput!`: (no description)

## seedSampleInventory

seedSampleInventory(input: SeedSampleInventoryInput!): SeedSampleInventoryResult

**Arguments**

- `input: SeedSampleInventoryInput!`: (no description)

## sendAdminBroadcast

sendAdminBroadcast(input: SendAdminBroadcastInput!): SendAdminBroadcastPayload

**Arguments**

- `input: SendAdminBroadcastInput!`: (no description)

## setOnboardingPersona

setOnboardingPersona(input: SetOnboardingPersonaInput!): SetOnboardingPersonaResult

**Arguments**

- `input: SetOnboardingPersonaInput!`: (no description)

## shipStockTransfer

shipStockTransfer(input: ShipStockTransferInput!): ShipStockTransferPayload

**Arguments**

- `input: ShipStockTransferInput!`: (no description)

## skipOnboardingStep

skipOnboardingStep(input: SkipOnboardingStepInput!): OnboardingProgressView

**Arguments**

- `input: SkipOnboardingStepInput!`: (no description)

## sourceFulfillmentOrder

Select fulfillment nodes for an existing fulfillment order and record the sourcing decision.

sourceFulfillmentOrder(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## startCountSession

startCountSession(input: StartCountSessionInput!): StartCountSessionPayload

**Arguments**

- `input: StartCountSessionInput!`: (no description)

## startFulfillmentOrderPicking

startFulfillmentOrderPicking(input: StartFulfillmentOrderPickingInput!): FulfillmentOrderStatusPayload

**Arguments**

- `input: StartFulfillmentOrderPickingInput!`: (no description)

## startOnboarding

startOnboarding(input: StartOnboardingInput!): StartOnboardingResult

**Arguments**

- `input: StartOnboardingInput!`: (no description)

## suppressChannelListing

suppressChannelListing(input: SuppressChannelListingInput!): SuppressChannelListingPayload

**Arguments**

- `input: SuppressChannelListingInput!`: (no description)

## uninstallShopifyConnector

uninstallShopifyConnector(input: UninstallShopifyConnectorInput!): ConnectorCommandPayload

**Arguments**

- `input: UninstallShopifyConnectorInput!`: (no description)

## updateAnalyticsAlert

updateAnalyticsAlert(input: UpdateAnalyticsAlertInput!): AnalyticsAlertResult

**Arguments**

- `input: UpdateAnalyticsAlertInput!`: (no description)

## updateDropshipFeed

updateDropshipFeed(input: UpdateDropshipFeedInput!): UpdateDropshipFeedPayload

**Arguments**

- `input: UpdateDropshipFeedInput!`: (no description)

## updateFutureSupply

Mutate expected_on, quantity, or confidence_score on an open future-quantity row.

updateFutureSupply(input: UpdateFutureSupplyInput!): FutureSupplyMutationResult

**Arguments**

- `input: UpdateFutureSupplyInput!`: (no description)

## updateLocation

updateLocation(input: UpdateLocationInput!): UpdateLocationPayload

**Arguments**

- `input: UpdateLocationInput!`: (no description)

## updateProduct

updateProduct(input: UpdateProductInput!): UpdateProductResult

**Arguments**

- `input: UpdateProductInput!`: (no description)

## updateProductVariant

updateProductVariant(input: UpdateProductVariantInput!): UpdateProductVariantResult

**Arguments**

- `input: UpdateProductVariantInput!`: (no description)

## upsertAccountAllocationPool

Create or update an account allocation pool for customer, tier, business-unit, market, or channel scoped inventory.

upsertAccountAllocationPool(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## upsertBusinessUnit

upsertBusinessUnit(input: UpsertBusinessUnitInput!): BusinessUnitPayload

**Arguments**

- `input: UpsertBusinessUnitInput!`: (no description)

## upsertChannelAssignment

upsertChannelAssignment(input: UpsertChannelAssignmentInput!): ChannelAssignmentPayload

**Arguments**

- `input: UpsertChannelAssignmentInput!`: (no description)

## upsertChannelListing

upsertChannelListing(input: UpsertChannelListingInput!): ChannelListingPayload

**Arguments**

- `input: UpsertChannelListingInput!`: (no description)

## upsertChannelOffer

upsertChannelOffer(input: UpsertChannelOfferInput!): ChannelOfferPayload

**Arguments**

- `input: UpsertChannelOfferInput!`: (no description)

## upsertCommerceMarket

upsertCommerceMarket(input: UpsertCommerceMarketInput!): CommerceMarketPayload

**Arguments**

- `input: UpsertCommerceMarketInput!`: (no description)

## upsertCustomerTier

Create or update a B2B/B2C customer tier used by account allocation pools.

upsertCustomerTier(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## upsertCustomField

upsertCustomField(input: UpsertCustomFieldInput!): UpsertCustomFieldPayload

**Arguments**

- `input: UpsertCustomFieldInput!`: (no description)

## upsertJobSchedule

upsertJobSchedule(input: UpsertJobScheduleInput!): UpsertJobSchedulePayload

**Arguments**

- `input: UpsertJobScheduleInput!`: (no description)

## upsertLocationOperatingException

upsertLocationOperatingException(input: UpsertLocationOperatingExceptionInput!): UpsertLocationOperatingExceptionPayload

**Arguments**

- `input: UpsertLocationOperatingExceptionInput!`: (no description)

## upsertLocationOperatingHours

upsertLocationOperatingHours(input: UpsertLocationOperatingHoursInput!): UpsertLocationOperatingHoursPayload

**Arguments**

- `input: UpsertLocationOperatingHoursInput!`: (no description)

## upsertSourcingCondition

Create or update a sourcing strategy condition.

upsertSourcingCondition(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## upsertSourcingCriterion

Create or update a sourcing strategy scoring criterion.

upsertSourcingCriterion(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## upsertSourcingGoal

Create or update a goal-directed sourcing objective for operators and agents.

upsertSourcingGoal(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## upsertSourcingProfile

Create or update a sourcing profile for fulfillment routing.

upsertSourcingProfile(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## upsertSourcingStrategy

Create or update a sourcing strategy under a profile.

upsertSourcingStrategy(input: InventoryCommandJsonInput!): InventoryCommandPayload

**Arguments**

- `input: InventoryCommandJsonInput!`: (no description)

## upsertSubstituteGroup

upsertSubstituteGroup(input: UpsertSubstituteGroupInput!): UpsertSubstituteGroupPayload

**Arguments**

- `input: UpsertSubstituteGroupInput!`: (no description)

## upsertSubstituteMember

upsertSubstituteMember(input: UpsertSubstituteMemberInput!): UpsertSubstituteMemberPayload

**Arguments**

- `input: UpsertSubstituteMemberInput!`: (no description)

## upsertTenantConfig

upsertTenantConfig(input: UpsertTenantConfigInput!): UpsertTenantConfigPayload

**Arguments**

- `input: UpsertTenantConfigInput!`: (no description)

## upsertTenantEnvironment

upsertTenantEnvironment(input: UpsertTenantEnvironmentInput!): UpsertTenantEnvironmentPayload

**Arguments**

- `input: UpsertTenantEnvironmentInput!`: (no description)

## upsertWebhookSubscription

upsertWebhookSubscription(input: UpsertWebhookSubscriptionInput!): UpsertWebhookSubscriptionPayload

**Arguments**

- `input: UpsertWebhookSubscriptionInput!`: (no description)

---

## GraphQL queries

URL: https://www.karmanflow.com/developers/reference/graphql/queries
Summary: Read entry points exposed by the KarmanFlow GraphQL API.

# 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)

---

## GraphQL scalars

URL: https://www.karmanflow.com/developers/reference/graphql/scalars
Summary: Scalar types in the KarmanFlow GraphQL schema.

# GraphQL scalars

Scalar types in the KarmanFlow GraphQL schema.

## BigInt

Arbitrary-precision integer encoded as a decimal string

## DateTime

ISO-8601 date-time

## JSON

Arbitrary JSON value

---

## GraphQL object types

URL: https://www.karmanflow.com/developers/reference/graphql/types
Summary: Object types in the KarmanFlow GraphQL schema.

# GraphQL object types

Object types in the KarmanFlow GraphQL schema.

## AccountPoolClamp

Account allocation pool matched for the request's customer tier.

| Field | Type | Description |
| --- | --- | --- |
| `poolId` | `ID` |  |
| `poolName` | `String` |  |
| `remainingForCaller` | `Float` |  |
| `reservedQty` | `Float` |  |
| `usedQty` | `Float` |  |

## AcknowledgeIncidentResult

| Field | Type | Description |
| --- | --- | --- |
| `acknowledgedBy` | `String` |  |
| `commandId` | `ID` |  |
| `error` | `IncidentMutationError` |  |
| `eventId` | `ID` |  |
| `incidentId` | `ID` |  |
| `newVersion` | `Int` |  |
| `reason` | `String` |  |
| `replayed` | `Boolean` |  |
| `state` | `String` |  |
| `status` | `String` |  |
| `success` | `Boolean` |  |

## Address

| Field | Type | Description |
| --- | --- | --- |
| `company` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `isDefault` | `Boolean` |  |
| `kind` | `String` |  |
| `partyId` | `ID` |  |
| `phone` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `verificationStatus` | `String` |  |
| `version` | `Int` |  |

## AdjustInventoryPayload

| Field | Type | Description |
| --- | --- | --- |
| `availableToPromise` | `String` |  |
| `channelAvailabilityUpdates` | `Int` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `inventoryLevelId` | `ID` |  |
| `movementId` | `ID` |  |
| `newQuantity` | `String` |  |
| `newVersion` | `Int` |  |
| `previousQuantity` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## AdminBroadcast

| Field | Type | Description |
| --- | --- | --- |
| `actionLabel` | `String` |  |
| `actionPayload` | `JSON` |  |
| `actionRouteRef` | `String` |  |
| `actionUrl` | `String` |  |
| `body` | `String` |  |
| `contentHash` | `String` |  |
| `createdOn` | `DateTime` |  |
| `deliveryCount` | `Int` |  |
| `environmentId` | `ID` |  |
| `expiresOn` | `DateTime` |  |
| `feedBadgeLabel` | `String` |  |
| `feedBadgeTone` | `String` |  |
| `feedCategory` | `String` |  |
| `feedMetadata` | `JSON` |  |
| `id` | `ID` |  |
| `publishedOn` | `DateTime` |  |
| `severity` | `String` |  |
| `sourceAppInstallationId` | `ID` |  |
| `sourceEventId` | `ID` |  |
| `status` | `String` |  |
| `targetAppInstallationId` | `ID` |  |
| `targetRole` | `String` |  |
| `targetScope` | `String` |  |
| `targetUserId` | `ID` |  |
| `tenantId` | `ID` |  |
| `title` | `String` |  |
| `triggerEntityId` | `ID` |  |
| `triggerEntityType` | `String` |  |
| `triggerEventType` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## AdminUserActivitySession

| Field | Type | Description |
| --- | --- | --- |
| `appId` | `String` |  |
| `appInstallationId` | `ID` |  |
| `appNamespace` | `String` |  |
| `appSurface` | `String` |  |
| `browserName` | `String` |  |
| `deviceLabel` | `String` |  |
| `deviceType` | `String` |  |
| `endedOn` | `DateTime` |  |
| `environmentId` | `ID` |  |
| `hitCount` | `Int` |  |
| `id` | `ID` |  |
| `idleSeconds` | `Int` |  |
| `ipHash` | `String` |  |
| `lastSeenOn` | `DateTime` |  |
| `osName` | `String` |  |
| `sessionAgeSeconds` | `Int` |  |
| `startedOn` | `DateTime` |  |
| `status` | `String` |  |
| `tenantId` | `ID` |  |
| `userAgent` | `String` |  |
| `userDisplayName` | `String` |  |
| `userEmail` | `String` |  |
| `userId` | `ID` |  |
| `version` | `Int` |  |
| `webSessionCreatedOn` | `DateTime` |  |
| `webSessionId` | `ID` |  |
| `webSessionLastSeenOn` | `DateTime` |  |

## AdminUserActivitySummary

| Field | Type | Description |
| --- | --- | --- |
| `activeAppSessions` | `Int` |  |
| `activeApps` | `Int` |  |
| `activeUsers` | `Int` |  |
| `activeWebSessions` | `Int` |  |
| `broadcastsSent` | `Int` |  |
| `environmentId` | `ID` |  |
| `queuedDeliveries` | `Int` |  |
| `tenantId` | `ID` |  |

## AgentDefinition

| Field | Type | Description |
| --- | --- | --- |
| `agentId` | `String` |  |
| `allowedSkills` | `JSON` |  |
| `allowedTools` | `JSON` |  |
| `approvalPolicy` | `JSON` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `dataAccess` | `JSON` |  |
| `defaultBudgets` | `JSON` |  |
| `defaultMode` | `String` |  |
| `definitionVersion` | `String` |  |
| `evalMetadata` | `JSON` |  |
| `handoffTargets` | `JSON` |  |
| `id` | `ID` |  |
| `killSwitchFlag` | `String` |  |
| `modelProfile` | `String` |  |
| `owner` | `String` |  |
| `ownerLane` | `String` |  |
| `promptVersion` | `String` |  |
| `riskCeiling` | `String` |  |
| `role` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `tenantOverrideConfigKey` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## AgentInstallation

| Field | Type | Description |
| --- | --- | --- |
| `agentDefinitionId` | `String` |  |
| `capabilityGrant` | `JSON` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `expiresOn` | `DateTime` |  |
| `id` | `ID` |  |
| `installedBy` | `String` |  |
| `installedOn` | `DateTime` |  |
| `revokedOn` | `DateTime` |  |
| `revokedReason` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## AgentRun

| Field | Type | Description |
| --- | --- | --- |
| `actorId` | `String` |  |
| `actorType` | `String` |  |
| `agentId` | `String` |  |
| `agentInstallationId` | `String` |  |
| `agentVersion` | `String` |  |
| `causationId` | `String` |  |
| `completedOn` | `DateTime` |  |
| `correlationId` | `String` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `metadata` | `JSON` |  |
| `scheduledJobId` | `String` |  |
| `startedOn` | `DateTime` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `trigger` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## AnalyticsAlertResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `ruleId` | `ID` |  |
| `ruleKey` | `String` |  |
| `scope` | `AnalyticsAlertScope` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## AnalyticsExport

One analytics export job row. Lifecycle is REQUESTED -&gt; RUNNING -&gt; COMPLETED | FAILED. The `signedUrlId` field is an opaque handle; call `mintAnalyticsExportSignedUrl(signedUrlId)` to produce the actual download URL. The signed URL itself is NEVER stored on this row, in any event payload, or in any audit record.

| Field | Type | Description |
| --- | --- | --- |
| `bucketRangeFrom` | `DateTime` |  |
| `bucketRangeTo` | `DateTime` |  |
| `completedAt` | `DateTime` |  |
| `environmentId` | `String` |  |
| `failureReason` | `String` |  |
| `format` | `String` |  |
| `id` | `ID` |  |
| `kmsKeyAlias` | `String` |  |
| `objectRef` | `String` |  |
| `reportDef` | `JSON` |  |
| `requestedAt` | `DateTime` |  |
| `requestedBy` | `String` |  |
| `scope` | `String` |  |
| `signedUrlId` | `ID` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## AnalyticsExportMutationResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `exportId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `rowStatus` | `String` |  |
| `status` | `String` |  |

## AnalyticsExportSignedUrl

Short-lived signed download URL for a COMPLETED analytics export artifact. Minted lazily on consume; never stored on the row, never carried in any event payload.

| Field | Type | Description |
| --- | --- | --- |
| `expiresAt` | `DateTime` |  |
| `url` | `String` |  |

## ApiKey

API key metadata. The token, the hashed token (key_hash), and any constraint payload are intentionally not exposed through GraphQL; the credential itself is only returned at issuance.

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `displayName` | `String` |  |
| `environmentId` | `String` |  |
| `environmentType` | `String` |  |
| `expiresOn` | `DateTime` |  |
| `id` | `ID` |  |
| `keyPrefix` | `String` |  |
| `lastUsedOn` | `DateTime` |  |
| `revokedOn` | `DateTime` |  |
| `revokedReason` | `String` |  |
| `rotatedFromApiKeyId` | `String` |  |
| `scopes` | `JSON` |  |
| `status` | `String` |  |
| `subjectId` | `String` |  |
| `subjectType` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## AppFeedItem

| Field | Type | Description |
| --- | --- | --- |
| `acknowledgedOn` | `DateTime` |  |
| `actionLabel` | `String` |  |
| `actionPayload` | `JSON` |  |
| `actionRouteRef` | `String` |  |
| `actionUrl` | `String` |  |
| `appInstallationId` | `ID` |  |
| `appUserSessionId` | `ID` |  |
| `body` | `String` |  |
| `broadcastId` | `ID` |  |
| `contentHash` | `String` |  |
| `deliveredOn` | `DateTime` |  |
| `dismissedOn` | `DateTime` |  |
| `environmentId` | `ID` |  |
| `expiresOn` | `DateTime` |  |
| `feedBadgeLabel` | `String` |  |
| `feedBadgeTone` | `String` |  |
| `feedCategory` | `String` |  |
| `feedMetadata` | `JSON` |  |
| `id` | `ID` |  |
| `publishedOn` | `DateTime` |  |
| `queuedOn` | `DateTime` |  |
| `severity` | `String` |  |
| `sourceAppInstallationId` | `ID` |  |
| `sourceEventId` | `ID` |  |
| `status` | `String` |  |
| `targetScope` | `String` |  |
| `tenantId` | `ID` |  |
| `title` | `String` |  |
| `triggerEntityId` | `ID` |  |
| `triggerEntityType` | `String` |  |
| `triggerEventType` | `String` |  |
| `userId` | `ID` |  |
| `version` | `Int` |  |
| `webSessionId` | `ID` |  |

## AppFeedItemStatePayload

| Field | Type | Description |
| --- | --- | --- |
| `acknowledgedOn` | `String` |  |
| `appInstallationId` | `ID` |  |
| `appUserSessionId` | `ID` |  |
| `broadcastId` | `ID` |  |
| `commandId` | `ID` |  |
| `commandStatus` | `String` |  |
| `deliveredOn` | `String` |  |
| `deliveryId` | `ID` |  |
| `dismissedOn` | `String` |  |
| `eventId` | `ID` |  |
| `previousStatus` | `String` |  |
| `queuedOn` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `userId` | `ID` |  |
| `version` | `Int` |  |
| `webSessionId` | `ID` |  |

## AppInstallation

| Field | Type | Description |
| --- | --- | --- |
| `appId` | `String` |  |
| `approvalReceiptId` | `ID` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `currentVersion` | `AppInstallationVersion` |  |
| `currentVersionId` | `ID` |  |
| `environmentId` | `ID` |  |
| `id` | `ID` |  |
| `installedBy` | `String` |  |
| `installedOn` | `DateTime` |  |
| `namespace` | `String` |  |
| `partnerOrgId` | `ID` |  |
| `revokeReceiptId` | `ID` |  |
| `revokedOn` | `DateTime` |  |
| `revokedReason` | `String` |  |
| `runtimeTargetId` | `ID` |  |
| `runtimeTargetKind` | `String` |  |
| `status` | `String` |  |
| `suspendedOn` | `DateTime` |  |
| `tenantId` | `ID` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## AppInstallationVersion

| Field | Type | Description |
| --- | --- | --- |
| `appId` | `String` |  |
| `appVersion` | `String` |  |
| `approvalReceiptId` | `ID` |  |
| `approvedScopes` | `JSON` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `ID` |  |
| `featureId` | `String` |  |
| `hashes` | `AppInstallationVersionHashes` |  |
| `id` | `ID` |  |
| `installationId` | `ID` |  |
| `installedBy` | `String` |  |
| `installedOn` | `DateTime` |  |
| `manifestHash` | `String` |  |
| `manifestSnapshot` | `JSON` |  |
| `requestedScopes` | `JSON` |  |
| `resolvedContributions` | `JSON` |  |
| `resolvedContributionsHash` | `String` |  |
| `riskCeiling` | `String` |  |
| `tenantId` | `ID` |  |

## AppInstallationVersionHashes

| Field | Type | Description |
| --- | --- | --- |
| `manifestHash` | `String` |  |
| `resolvedContributionsHash` | `String` |  |

## ApplyCountVariancePayload

| Field | Type | Description |
| --- | --- | --- |
| `appliedDelta` | `String` |  |
| `availableToPromise` | `String` |  |
| `channelAvailabilityUpdates` | `Int` |  |
| `commandId` | `ID` |  |
| `countLineId` | `ID` |  |
| `countSessionId` | `ID` |  |
| `countedQuantity` | `String` |  |
| `eventId` | `ID` |  |
| `inventoryLevelId` | `ID` |  |
| `movementId` | `ID` |  |
| `newQuantity` | `String` |  |
| `newVersion` | `Int` |  |
| `previousQuantity` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## ApprovalRequest

| Field | Type | Description |
| --- | --- | --- |
| `boundCommandReceiptId` | `String` |  |
| `causationId` | `String` |  |
| `commandType` | `String` |  |
| `correlationId` | `String` |  |
| `createdBy` | `String` |  |
| `dueOn` | `DateTime` |  |
| `entityId` | `String` |  |
| `entityType` | `String` |  |
| `environmentId` | `String` |  |
| `expiresOn` | `DateTime` |  |
| `id` | `ID` |  |
| `requestedAction` | `String` |  |
| `requestedById` | `String` |  |
| `requestedByType` | `String` |  |
| `requestedReason` | `String` |  |
| `resolutionReason` | `String` |  |
| `resolvedById` | `String` |  |
| `resolvedByType` | `String` |  |
| `resolvedOn` | `DateTime` |  |
| `resourceId` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |

## AssignPartyRolePayload

| Field | Type | Description |
| --- | --- | --- |
| `assigned` | `Boolean` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `partyId` | `ID` |  |
| `partyRoleId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `roleStatus` | `String` |  |
| `roleType` | `String` |  |
| `scopeId` | `ID` |  |
| `scopeType` | `String` |  |
| `status` | `String` |  |
| `version` | `Int` |  |

## AvailabilityComponent

One contributor to availability(availableOn:). `source` is either `NODE_AVAILABLE` (scalar ATP from the InventoryLevel hot path) or one of the InventoryFutureQuantity source_type values. `expectedOn` is null for the NODE_AVAILABLE row.

| Field | Type | Description |
| --- | --- | --- |
| `expectedOn` | `DateTime` |  |
| `quantity` | `Float` |  |
| `source` | `String` |  |

## AvailabilityResult

Composition of the scalar NodeAvailable plus the future-supply walk for the requested availableOn point. `atp` already clamps to zero; `components` enumerates the contributing rows.

| Field | Type | Description |
| --- | --- | --- |
| `atp` | `Float` |  |
| `available` | `Float` |  |
| `components` | `[AvailabilityComponent!]` |  |
| `projectedOn` | `DateTime` |  |

## BusinessUnit

| Field | Type | Description |
| --- | --- | --- |
| `description` | `String` |  |
| `displayName` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `parentBuId` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `unitKey` | `String` |  |
| `version` | `Int` |  |

## BusinessUnitPayload

| Field | Type | Description |
| --- | --- | --- |
| `businessUnitId` | `ID` |  |
| `created` | `Boolean` |  |
| `environmentId` | `String` |  |
| `newVersion` | `Int` |  |
| `unitKey` | `String` |  |

## CancelFulfillmentOrderPayload

| Field | Type | Description |
| --- | --- | --- |
| `cancellationReason` | `String` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `fulfillmentOrderId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## CancelReturnPayload

| Field | Type | Description |
| --- | --- | --- |
| `cancellationReason` | `String` |  |
| `cancelledOn` | `String` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `returnId` | `ID` |  |
| `status` | `String` |  |

## CancelStockTransferPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `stockTransferId` | `ID` |  |

## ChannelAssignment

| Field | Type | Description |
| --- | --- | --- |
| `assignmentKey` | `String` |  |
| `businessUnitId` | `String` |  |
| `channelExposureStrategyId` | `String` |  |
| `commerceMarketId` | `String` |  |
| `eligibilityProfileId` | `String` |  |
| `environmentId` | `String` |  |
| `fulfillmentNetworkId` | `String` |  |
| `id` | `ID` |  |
| `priority` | `Int` |  |
| `salesChannelId` | `String` |  |
| `scopeKind` | `String` |  |
| `sourcingProfileId` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## ChannelAssignmentPayload

| Field | Type | Description |
| --- | --- | --- |
| `assignmentId` | `ID` |  |
| `assignmentKey` | `String` |  |
| `created` | `Boolean` |  |
| `environmentId` | `String` |  |
| `newVersion` | `Int` |  |
| `scopeKind` | `String` |  |

## ChannelAvailability

| Field | Type | Description |
| --- | --- | --- |
| `availableToSell` | `Float` |  |
| `channelBuffer` | `Float` |  |
| `channelId` | `ID` |  |
| `createdBy` | `String` |  |
| `customFields` | `JSON` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `locationId` | `ID` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `variantId` | `ID` |  |

## ChannelListing

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `String` |  |
| `description` | `String` |  |
| `environmentId` | `String` |  |
| `externalListingId` | `String` |  |
| `id` | `ID` |  |
| `listingStatus` | `String` |  |
| `productId` | `String` |  |
| `publishedOn` | `String` |  |
| `suppressedReason` | `String` |  |
| `tenantId` | `String` |  |
| `title` | `String` |  |
| `variantId` | `String` |  |
| `version` | `Int` |  |

## ChannelListingPayload

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `String` |  |
| `created` | `Boolean` |  |
| `environmentId` | `String` |  |
| `listingId` | `ID` |  |
| `listingStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `variantId` | `String` |  |

## ChannelOffer

| Field | Type | Description |
| --- | --- | --- |
| `compareAtPriceMinor` | `Int` |  |
| `currency` | `String` |  |
| `effectiveFrom` | `String` |  |
| `effectiveTo` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `listingId` | `String` |  |
| `priceListId` | `String` |  |
| `priceMinor` | `Int` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## ChannelOfferPayload

| Field | Type | Description |
| --- | --- | --- |
| `created` | `Boolean` |  |
| `currency` | `String` |  |
| `effectiveFrom` | `String` |  |
| `environmentId` | `String` |  |
| `listingId` | `String` |  |
| `newVersion` | `Int` |  |
| `offerId` | `ID` |  |
| `priceMinor` | `Int` |  |

## CleanupSampleDataResult

| Field | Type | Description |
| --- | --- | --- |
| `cleanedOn` | `DateTime` |  |
| `commandId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `rowsDeleted` | `JSON` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `totalRowsDeleted` | `Int` |  |

## ClearSampleDataResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `deletedCount` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## CloseCountSessionPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `countSessionId` | `ID` |  |
| `currentStatus` | `String` |  |
| `eventId` | `ID` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## CommandPolicySimulation

| Field | Type | Description |
| --- | --- | --- |
| `actorId` | `String` |  |
| `actorType` | `String` |  |
| `aggregate` | `String` |  |
| `commandType` | `String` |  |
| `effect` | `String` |  |
| `effectiveRoles` | `[String!]` |  |
| `effectiveScopes` | `[String!]` |  |
| `missingScopes` | `[String!]` |  |
| `policySourceTenantId` | `String` |  |
| `policyVersion` | `Int` |  |
| `reason` | `String` |  |
| `requiredScopes` | `[String!]` |  |
| `requiresApproval` | `Boolean` |  |
| `requiresApprovalFor` | `[String!]` |  |
| `resourceId` | `String` |  |
| `resourceKind` | `String` |  |
| `riskClass` | `String` |  |
| `rule` | `String` |  |
| `skippedGrants` | `JSON` |  |

## CommandReceipt

| Field | Type | Description |
| --- | --- | --- |
| `actorId` | `String` |  |
| `actorType` | `String` |  |
| `agentRunId` | `String` |  |
| `approvalRequestId` | `String` |  |
| `causationId` | `String` |  |
| `commandId` | `ID` |  |
| `commandType` | `String` |  |
| `completedOn` | `DateTime` |  |
| `correlationId` | `String` |  |
| `entityId` | `String` |  |
| `entityType` | `String` |  |
| `environmentId` | `String` |  |
| `idempotencyKey` | `String` |  |
| `policyContext` | `JSON` |  |
| `requestedOn` | `DateTime` |  |
| `responsePayload` | `JSON` |  |
| `skillRunId` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `traceparent` | `String` |  |

## CommerceMarket

| Field | Type | Description |
| --- | --- | --- |
| `countryCodes` | `[String!]` |  |
| `defaultCurrency` | `String` |  |
| `description` | `String` |  |
| `displayName` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `marketKey` | `String` |  |
| `marketType` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## CommerceMarketPayload

| Field | Type | Description |
| --- | --- | --- |
| `created` | `Boolean` |  |
| `environmentId` | `String` |  |
| `marketId` | `ID` |  |
| `marketKey` | `String` |  |
| `newVersion` | `Int` |  |

## CommitBundleReservationResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `committedMemberCount` | `Int` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `groupId` | `ID` |  |
| `groupStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `orderId` | `ID` |  |
| `previousVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## CommitReservationPayload

| Field | Type | Description |
| --- | --- | --- |
| `availableToPromise` | `String` |  |
| `channelAvailabilityUpdates` | `Int` |  |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `inventoryLevelId` | `ID` |  |
| `inventoryLevelVersion` | `Int` |  |
| `movementGroupId` | `ID` |  |
| `previousStatus` | `String` |  |
| `quantity` | `String` |  |
| `replayed` | `Boolean` |  |
| `reservationId` | `ID` |  |
| `reservationVersion` | `Int` |  |
| `status` | `String` |  |

## CompositeAvailability

| Field | Type | Description |
| --- | --- | --- |
| `dropshipContribution` | `Float` |  |
| `nodeAvailable` | `Float` |  |
| `substituteContribution` | `Float` |  |
| `totalAvailable` | `Float` |  |
| `variantId` | `ID` |  |

## ConfigureTenantDefaultsResult

| Field | Type | Description |
| --- | --- | --- |
| `agentsInstalled` | `Int` |  |
| `agentsSkipped` | `Int` |  |
| `channelsCreated` | `Int` |  |
| `commandId` | `ID` |  |
| `configKeysWritten` | `[String!]` |  |
| `environmentId` | `String` |  |
| `locationsCreated` | `Int` |  |
| `overrideApplied` | `Boolean` |  |
| `persona` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## ConnectorBinding

Connector binding (vendor account install). Secret material (access_token_secret_ref) is held in the secret broker and is not exposed through GraphQL.

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `externalRef` | `String` |  |
| `id` | `ID` |  |
| `installedAt` | `DateTime` |  |
| `installedBy` | `String` |  |
| `provider` | `String` |  |
| `revokedAt` | `DateTime` |  |
| `revokedReason` | `String` |  |
| `scope` | `JSON` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## ConnectorCommandPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `response` | `JSON` |  |
| `status` | `String` |  |

## ContactPoint

| Field | Type | Description |
| --- | --- | --- |
| `contactType` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `partyId` | `ID` |  |
| `preferred` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `verificationStatus` | `String` |  |
| `version` | `Int` |  |

## ContextPack

| Field | Type | Description |
| --- | --- | --- |
| `activePolicies` | `[ContextPackPolicy!]` |  |
| `availableReadTools` | `[String!]` |  |
| `entitySummary` | `ContextPackEntitySummary` |  |
| `freshness` | `ReadFreshness!` |  |
| `generatedAt` | `DateTime` |  |
| `hash` | `String` |  |
| `recentEvents` | `[ContextPackEvent!]` |  |
| `routePath` | `String` |  |
| `serializedMarkdown` | `String` |  |
| `version` | `String` |  |

## ContextPackEntitySummary

| Field | Type | Description |
| --- | --- | --- |
| `displayName` | `String` |  |
| `entityId` | `String` |  |
| `entityType` | `String` |  |
| `fieldsJson` | `JSON` |  |
| `updatedAt` | `DateTime` |  |

## ContextPackEvent

| Field | Type | Description |
| --- | --- | --- |
| `actorType` | `String` |  |
| `eventId` | `String` |  |
| `eventType` | `String` |  |
| `occurredAt` | `DateTime` |  |
| `summary` | `String` |  |

## ContextPackPolicy

| Field | Type | Description |
| --- | --- | --- |
| `configKey` | `String` |  |
| `requiresApproval` | `Boolean` |  |
| `summary` | `String` |  |
| `updatedAt` | `String` |  |

## ControlCenterAction

| Field | Type | Description |
| --- | --- | --- |
| `cliCommand` | `String` |  |
| `commandType` | `String` |  |
| `description` | `String` |  |
| `extensionModel` | `String` |  |
| `graphQLField` | `String` |  |
| `id` | `ID` |  |
| `label` | `String` |  |
| `lane` | `String` |  |
| `mcpTool` | `String` |  |
| `requiredScopes` | `[String!]` |  |
| `riskClass` | `String` |  |
| `route` | `String` |  |
| `status` | `String` |  |

## ControlCenterAppInstallation

| Field | Type | Description |
| --- | --- | --- |
| `appId` | `String` |  |
| `currentVersionId` | `ID` |  |
| `id` | `ID` |  |
| `installedOn` | `DateTime` |  |
| `namespace` | `String` |  |
| `partnerOrgId` | `ID` |  |
| `runtimeTargetId` | `ID` |  |
| `runtimeTargetKind` | `String` |  |
| `status` | `String` |  |
| `updatedOn` | `DateTime` |  |

## ControlCenterAttention

| Field | Type | Description |
| --- | --- | --- |
| `expiringReservations` | `Int` |  |
| `inactiveWebhooks` | `Int` |  |
| `openIncidents` | `Int` |  |
| `pendingApprovals` | `Int` |  |

## ControlCenterDeployment

| Field | Type | Description |
| --- | --- | --- |
| `cellId` | `String` |  |
| `databaseRef` | `String` |  |
| `deploymentKey` | `String` |  |
| `environmentId` | `ID` |  |
| `id` | `ID` |  |
| `isolationMode` | `String` |  |
| `lifecycleStage` | `String` |  |
| `queueLaneRef` | `String` |  |
| `region` | `String` |  |
| `schemaRef` | `String` |  |
| `status` | `String` |  |
| `storageMode` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `workerPoolRef` | `String` |  |

## ControlCenterEnvironment

| Field | Type | Description |
| --- | --- | --- |
| `activatedOn` | `DateTime` |  |
| `dataClassification` | `String` |  |
| `environmentKey` | `String` |  |
| `environmentType` | `String` |  |
| `id` | `ID` |  |
| `infraClass` | `String` |  |
| `lifecycleStage` | `String` |  |
| `name` | `String` |  |
| `status` | `String` |  |
| `updatedOn` | `DateTime` |  |

## ControlCenterEvent

| Field | Type | Description |
| --- | --- | --- |
| `entityId` | `ID` |  |
| `entityType` | `String` |  |
| `eventId` | `ID` |  |
| `eventType` | `String` |  |
| `occurredOn` | `DateTime` |  |

## ControlCenterSnapshot

| Field | Type | Description |
| --- | --- | --- |
| `actions` | `[ControlCenterAction!]` |  |
| `activitySummary` | `AdminUserActivitySummary` |  |
| `appInstallations` | `[ControlCenterAppInstallation!]` |  |
| `attention` | `ControlCenterAttention` |  |
| `broadcasts` | `[AdminBroadcast!]` |  |
| `deployments` | `[ControlCenterDeployment!]` |  |
| `environmentId` | `ID` |  |
| `environments` | `[ControlCenterEnvironment!]` |  |
| `generatedOn` | `DateTime` |  |
| `recentEvents` | `[ControlCenterEvent!]` |  |
| `tenantId` | `ID` |  |

## CreateAddressPayload

| Field | Type | Description |
| --- | --- | --- |
| `addressId` | `ID` |  |
| `addressStatus` | `String` |  |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `eventId` | `ID` |  |
| `kind` | `String` |  |
| `partyId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `version` | `Int` |  |

## CreateContactPointPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `contactPointId` | `ID` |  |
| `contactPointStatus` | `String` |  |
| `contactType` | `String` |  |
| `created` | `Boolean` |  |
| `eventId` | `ID` |  |
| `partyId` | `ID` |  |
| `preferred` | `Boolean` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `version` | `Int` |  |

## CreateDropshipLocationPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `connectorKey` | `String` |  |
| `dropshipSupplierPartyId` | `ID` |  |
| `environmentId` | `String` |  |
| `feedId` | `ID` |  |
| `locationId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## CreateExternalTaskPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `externalTaskId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## CreateFulfillmentOrderPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `eventId` | `ID` |  |
| `fulfillmentOrderId` | `ID` |  |
| `fulfillmentOrderStatus` | `String` |  |
| `fulfillmentRef` | `String` |  |
| `orderId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `version` | `Int` |  |

## CreateOrderPayload

| Field | Type | Description |
| --- | --- | --- |
| `allocatedEventId` | `ID` |  |
| `allocatedLineCount` | `Int` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `lineCount` | `Int` |  |
| `lineIds` | `[String!]` |  |
| `orderId` | `ID` |  |
| `orderRef` | `String` |  |
| `orderStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `reservationIds` | `[String!]` |  |
| `status` | `String` |  |

## CreatePartyPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `eventId` | `ID` |  |
| `partyId` | `ID` |  |
| `partyStatus` | `String` |  |
| `partyType` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `version` | `Int` |  |

## CreateProductResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `name` | `String` |  |
| `productId` | `ID` |  |
| `productRef` | `String` |  |
| `productStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## CreateProductVariantResult

| Field | Type | Description |
| --- | --- | --- |
| `barcode` | `String` |  |
| `commandId` | `ID` |  |
| `defaultShelfLifeDays` | `Int` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `exportControlClass` | `String` |  |
| `hazmatClass` | `String` |  |
| `hsCode` | `String` |  |
| `optionValues` | `JSON` |  |
| `productId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `requiresExpiryTracking` | `Boolean` |  |
| `requiresLotTracking` | `Boolean` |  |
| `requiresSerialTracking` | `Boolean` |  |
| `sku` | `String` |  |
| `status` | `String` |  |
| `temperatureZone` | `String` |  |
| `tenantId` | `String` |  |
| `trackingType` | `String` |  |
| `uom` | `String` |  |
| `variantId` | `ID` |  |
| `variantStatus` | `String` |  |
| `version` | `Int` |  |

## CreateReservationPayload

| Field | Type | Description |
| --- | --- | --- |
| `availableToPromise` | `String` |  |
| `channelAvailabilityUpdates` | `Int` |  |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `inventoryLevelId` | `ID` |  |
| `quantity` | `String` |  |
| `replayed` | `Boolean` |  |
| `reservationId` | `ID` |  |
| `status` | `String` |  |

## CreateReturnPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `eventId` | `ID` |  |
| `orderId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `returnId` | `ID` |  |
| `returnRef` | `String` |  |
| `returnStatus` | `String` |  |
| `status` | `String` |  |
| `version` | `Int` |  |

## CreateShipmentPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `eventId` | `ID` |  |
| `fulfillmentOrderId` | `ID` |  |
| `lineIds` | `[String!]` |  |
| `replayed` | `Boolean` |  |
| `shipmentId` | `ID` |  |
| `shipmentRef` | `String` |  |
| `shipmentStatus` | `String` |  |
| `status` | `String` |  |
| `version` | `Int` |  |

## CreateStockTransferPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `stockTransferId` | `ID` |  |
| `transferRef` | `String` |  |

## CustomerServiceCommandPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `request` | `CustomerServiceRequest` |  |
| `response` | `JSON` |  |
| `status` | `String` |  |

## CustomerServiceRequest

| Field | Type | Description |
| --- | --- | --- |
| `addressId` | `ID` |  |
| `approvalRequestId` | `ID` |  |
| `channel` | `String` |  |
| `contactPointId` | `ID` |  |
| `contextBuiltOn` | `DateTime` |  |
| `contextFreshness` | `JSON` |  |
| `contextSnapshot` | `JSON` |  |
| `createdOn` | `DateTime` |  |
| `customerPartyId` | `ID` |  |
| `environmentId` | `String` |  |
| `escalatedOn` | `DateTime` |  |
| `escalationReason` | `String` |  |
| `fulfillmentOrderId` | `ID` |  |
| `id` | `ID` |  |
| `intentSummary` | `String` |  |
| `orderId` | `ID` |  |
| `progressiveActionId` | `ID` |  |
| `proposalActionFamily` | `String` |  |
| `proposalCommandPlan` | `JSON` |  |
| `proposalCustomerAnswer` | `String` |  |
| `proposalModelId` | `String` |  |
| `proposalPolicyDecision` | `String` |  |
| `proposalRationale` | `String` |  |
| `proposalRiskClass` | `String` |  |
| `proposedActionId` | `ID` |  |
| `proposedOn` | `DateTime` |  |
| `requestClass` | `String` |  |
| `requestRef` | `String` |  |
| `resolutionSummary` | `String` |  |
| `resolvedCommandReceiptId` | `ID` |  |
| `resolvedOn` | `DateTime` |  |
| `returnId` | `ID` |  |
| `shipmentId` | `ID` |  |
| `sourceArtifacts` | `JSON` |  |
| `state` | `String` |  |
| `subjectId` | `ID` |  |
| `subjectType` | `String` |  |
| `tenantId` | `String` |  |
| `triggerSource` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## CustomField

| Field | Type | Description |
| --- | --- | --- |
| `booleanValue` | `Boolean` |  |
| `createdOn` | `DateTime` |  |
| `cursor` | `String` |  |
| `dateValue` | `DateTime` |  |
| `entityId` | `ID` |  |
| `entityType` | `String` |  |
| `environmentId` | `String` |  |
| `fieldDefinitionId` | `ID` |  |
| `fieldGroup` | `String` |  |
| `fieldKey` | `String` |  |
| `id` | `ID` |  |
| `isIndexed` | `Boolean` |  |
| `jsonValue` | `JSON` |  |
| `numberValue` | `Float` |  |
| `sourceSystem` | `String` |  |
| `stringValue` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `value` | `JSON` |  |
| `valueType` | `String` |  |
| `version` | `Int` |  |

## CustomFieldConnection

| Field | Type | Description |
| --- | --- | --- |
| `edges` | `[CustomFieldEdge!]` |  |
| `pageInfo` | `CustomFieldPageInfo` |  |

## CustomFieldEdge

| Field | Type | Description |
| --- | --- | --- |
| `cursor` | `String` |  |
| `node` | `CustomField` |  |

## CustomFieldPageInfo

| Field | Type | Description |
| --- | --- | --- |
| `endCursor` | `String` |  |
| `hasNextPage` | `Boolean` |  |

## DeactivateChannelOfferPayload

| Field | Type | Description |
| --- | --- | --- |
| `currency` | `String` |  |
| `deactivatedAt` | `String` |  |
| `environmentId` | `String` |  |
| `listingId` | `String` |  |
| `newVersion` | `Int` |  |
| `offerId` | `ID` |  |

## DecommissionLocationPayload

| Field | Type | Description |
| --- | --- | --- |
| `closedOn` | `String` |  |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `decommissionedOn` | `String` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `locationId` | `ID` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `previousVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## DeleteSavedReportResult

| Field | Type | Description |
| --- | --- | --- |
| `alreadyDeleted` | `Boolean` |  |
| `commandId` | `ID` |  |
| `deletedOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `reportKey` | `String` |  |
| `savedReportId` | `ID` |  |
| `status` | `String` |  |
| `surface` | `String` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## DelistChannelListingPayload

| Field | Type | Description |
| --- | --- | --- |
| `environmentId` | `String` |  |
| `listingId` | `ID` |  |
| `newVersion` | `Int` |  |
| `priorStatus` | `String` |  |

## DispatchShipmentPayload

| Field | Type | Description |
| --- | --- | --- |
| `carrier` | `String` |  |
| `commandId` | `ID` |  |
| `dispatchedLineCount` | `Int` |  |
| `dispatchedOn` | `String` |  |
| `eventId` | `ID` |  |
| `fulfillmentOrderId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `shipmentId` | `ID` |  |
| `status` | `String` |  |
| `trackingRef` | `String` |  |

## DomainEvent

| Field | Type | Description |
| --- | --- | --- |
| `actorId` | `String` |  |
| `actorType` | `String` |  |
| `causationId` | `String` |  |
| `correlationId` | `String` |  |
| `entityId` | `String` |  |
| `entityType` | `String` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `eventType` | `String` |  |
| `occurredOn` | `DateTime` |  |
| `payload` | `JSON` |  |
| `streamKey` | `String` |  |
| `streamSequence` | `String` |  |
| `tenantId` | `String` |  |
| `traceparent` | `String` |  |

## DropshipFeed

| Field | Type | Description |
| --- | --- | --- |
| `connectorKey` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `errorCount` | `Int` |  |
| `feedType` | `String` |  |
| `id` | `ID` |  |
| `lastReceivedOn` | `DateTime` |  |
| `locationId` | `ID` |  |
| `scheduleCron` | `String` |  |
| `stalenessStatus` | `String` |  |
| `stalenessThresholdSeconds` | `Int` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `String` |  |

## ErasePartyPayload

| Field | Type | Description |
| --- | --- | --- |
| `approvalRequestId` | `ID` |  |
| `commandId` | `ID` |  |
| `erased` | `Boolean` |  |
| `erasedAddressCount` | `Int` |  |
| `erasedContactPointCount` | `Int` |  |
| `eventId` | `ID` |  |
| `partyId` | `ID` |  |
| `partyStatus` | `String` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `version` | `Int` |  |

## EscalateIncidentResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `error` | `IncidentMutationError` |  |
| `eventId` | `ID` |  |
| `incidentId` | `ID` |  |
| `newVersion` | `Int` |  |
| `reason` | `String` |  |
| `replayed` | `Boolean` |  |
| `state` | `String` |  |
| `status` | `String` |  |
| `success` | `Boolean` |  |

## ExecuteIncidentActionResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `error` | `IncidentMutationError` |  |
| `executedEventId` | `ID` |  |
| `incidentId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `resolvedCommandReceiptId` | `String` |  |
| `resolvedEventId` | `ID` |  |
| `state` | `String` |  |
| `status` | `String` |  |
| `success` | `Boolean` |  |

## ExpireReservationPayload

| Field | Type | Description |
| --- | --- | --- |
| `availableToPromise` | `String` |  |
| `channelAvailabilityUpdates` | `Int` |  |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `inventoryLevelId` | `ID` |  |
| `inventoryLevelVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `quantity` | `String` |  |
| `replayed` | `Boolean` |  |
| `reservationId` | `ID` |  |
| `reservationVersion` | `Int` |  |
| `status` | `String` |  |

## ExternalTask

| Field | Type | Description |
| --- | --- | --- |
| `entityId` | `String` |  |
| `entityType` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `status` | `String` |  |
| `targetSystem` | `String` |  |
| `taskType` | `String` |  |
| `tenantId` | `String` |  |

## FeatureActivationMaterialization

| Field | Type | Description |
| --- | --- | --- |
| `actorId` | `String` |  |
| `actorType` | `String` |  |
| `commands` | `[FeatureCommandContribution!]` |  |
| `environmentId` | `ID` |  |
| `eventType` | `String` |  |
| `events` | `[FeatureEventContribution!]` |  |
| `featureId` | `String` |  |
| `id` | `ID` |  |
| `kind` | `String` |  |
| `materializationCommandId` | `ID` |  |
| `materializedOn` | `DateTime` |  |
| `registryFingerprint` | `String` |  |
| `riskCeiling` | `String` |  |
| `tenantId` | `ID` |  |
| `traceparent` | `String` |  |
| `version` | `String` |  |

## FeatureCommandContribution

| Field | Type | Description |
| --- | --- | --- |
| `commandType` | `String` |  |
| `description` | `String` |  |
| `requiresApproval` | `Boolean` |  |
| `riskClass` | `String` |  |
| `scopes` | `[String!]` |  |

## FeatureEventContribution

| Field | Type | Description |
| --- | --- | --- |
| `description` | `String` |  |
| `eventType` | `String` |  |
| `priority` | `String` |  |

## FireAhaMomentResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `correlationId` | `String` |  |
| `fallbackToAdjustInventory` | `Boolean` |  |
| `locationId` | `ID` |  |
| `persona` | `String` |  |
| `replayed` | `Boolean` |  |
| `reservations` | `[FireAhaReservationOutcome!]` |  |
| `scenarioId` | `String` |  |
| `status` | `String` |  |
| `variantId` | `ID` |  |

## FireAhaReservationOutcome

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `ID` |  |
| `index` | `Int` |  |
| `reason` | `String` |  |
| `reservationId` | `ID` |  |
| `ruleId` | `String` |  |
| `status` | `String` |  |

## FlowTraceResult

| Field | Type | Description |
| --- | --- | --- |
| `anchors` | `JSON!` |  |
| `currentEntities` | `JSON!` |  |
| `events` | `JSON!` |  |
| `freshness` | `ReadFreshness!` |  |
| `ingestion` | `JSON!` |  |
| `inventoryMovements` | `JSON!` |  |
| `missing` | `JSON!` |  |
| `receipts` | `JSON!` |  |
| `selectors` | `JSON!` |  |
| `summary` | `JSON!` |  |
| `timeline` | `JSON!` |  |

## FulfillmentHold

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `fulfillmentOrderId` | `ID` |  |
| `heldOn` | `DateTime` |  |
| `id` | `ID` |  |
| `reasonCode` | `String` |  |
| `reasonDescription` | `String` |  |
| `releasedBy` | `String` |  |
| `releasedOn` | `DateTime` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## FulfillmentOrder

| Field | Type | Description |
| --- | --- | --- |
| `activeMarkerKeys` | `[String!]` |  |
| `allocatedOn` | `DateTime` |  |
| `cancellationReason` | `String` |  |
| `cancelledOn` | `DateTime` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `fulfilledOn` | `DateTime` |  |
| `fulfillmentRef` | `String` |  |
| `id` | `ID` |  |
| `orderId` | `ID` |  |
| `packedOn` | `DateTime` |  |
| `pickingStartedOn` | `DateTime` |  |
| `plannedDispatchOn` | `DateTime` |  |
| `priority` | `Int` |  |
| `shipToAddressId` | `ID` |  |
| `shipToPartyId` | `ID` |  |
| `sourceLocationId` | `ID` |  |
| `sourceSystem` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## FulfillmentOrderLine

| Field | Type | Description |
| --- | --- | --- |
| `cancelledQty` | `Float` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `fulfilledQty` | `Float` |  |
| `fulfillmentOrderId` | `ID` |  |
| `id` | `ID` |  |
| `orderLineId` | `ID` |  |
| `packedQty` | `Float` |  |
| `pickedQty` | `Float` |  |
| `plannedQty` | `Float` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `variantId` | `ID` |  |
| `version` | `Int` |  |

## FulfillmentOrderLinePackPayload

| Field | Type | Description |
| --- | --- | --- |
| `cancelledQty` | `Int` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `evidenceRef` | `String` |  |
| `fulfillmentOrderId` | `ID` |  |
| `fulfillmentOrderLineId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `packageRef` | `String` |  |
| `packedQty` | `Int` |  |
| `pickedQty` | `Int` |  |
| `plannedQty` | `Int` |  |
| `previousStatus` | `String` |  |
| `quantity` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## FulfillmentOrderLinePickPayload

| Field | Type | Description |
| --- | --- | --- |
| `cancelledQty` | `Int` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `evidenceRef` | `String` |  |
| `fulfillmentOrderId` | `ID` |  |
| `fulfillmentOrderLineId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `pickedQty` | `Int` |  |
| `plannedQty` | `Int` |  |
| `previousStatus` | `String` |  |
| `quantity` | `Int` |  |
| `replayed` | `Boolean` |  |
| `sourceBinId` | `ID` |  |
| `status` | `String` |  |

## FulfillmentOrderStatusPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `fulfillmentOrderId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## FutureAvailabilitySegment

A future supply segment projected for a given availableOn date.

| Field | Type | Description |
| --- | --- | --- |
| `availableOn` | `String` |  |
| `confidenceScore` | `Float` |  |
| `quantity` | `Float` |  |
| `source` | `String` |  |

## FutureSupplyMutationResult

Standard envelope for the four mutating future-supply commands. `eventId` is null when the underlying command emitted no domain event (e.g. CancelFutureSupply against an already-terminal row).

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `futureQuantityId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `rowStatus` | `String` |  |
| `status` | `String` |  |

## FutureSupplyTimelineEntry

One inventory.future.* domain event for a source line. The full event payload is exposed as JSON so support and audit tooling can inspect prior expected_on, confidence, and reason codes without per-field reshaping.

| Field | Type | Description |
| --- | --- | --- |
| `eventId` | `ID` |  |
| `eventType` | `String` |  |
| `futureQuantityId` | `ID` |  |
| `occurredOn` | `DateTime` |  |
| `payload` | `JSON` |  |

## Incident

| Field | Type | Description |
| --- | --- | --- |
| `acknowledgedOn` | `DateTime` |  |
| `approvalRequestId` | `String` |  |
| `attributes` | `JSON` |  |
| `code` | `String` |  |
| `environmentId` | `String` |  |
| `escalatedOn` | `DateTime` |  |
| `executedOn` | `DateTime` |  |
| `faultClass` | `String` |  |
| `fingerprint` | `String` |  |
| `id` | `ID` |  |
| `lastSignalId` | `String` |  |
| `lastSignalOn` | `DateTime` |  |
| `openedOn` | `DateTime` |  |
| `proposalCommandType` | `String` |  |
| `proposalDryRun` | `JSON` |  |
| `proposalEvalScore` | `Float` |  |
| `proposalInput` | `JSON` |  |
| `proposalModelId` | `String` |  |
| `proposalPolicyDecision` | `String` |  |
| `proposalRationale` | `String` |  |
| `proposalRiskClass` | `String` |  |
| `proposedActionId` | `String` |  |
| `proposedOn` | `DateTime` |  |
| `resolutionReason` | `String` |  |
| `resolvedCommandReceiptId` | `String` |  |
| `resolvedOn` | `DateTime` |  |
| `severity` | `String` |  |
| `signalCount` | `Int` |  |
| `state` | `String` |  |
| `surface` | `String` |  |
| `tenantId` | `String` |  |
| `triageSkill` | `String` |  |
| `triagedOn` | `DateTime` |  |
| `version` | `Int` |  |

## IncidentConnection

| Field | Type | Description |
| --- | --- | --- |
| `edges` | `[IncidentEdge!]` |  |
| `pageInfo` | `IncidentPageInfo` |  |

## IncidentEdge

| Field | Type | Description |
| --- | --- | --- |
| `cursor` | `String` |  |
| `node` | `Incident` |  |

## IncidentMutationError

| Field | Type | Description |
| --- | --- | --- |
| `actualState` | `String` |  |
| `actualVersion` | `Int` |  |
| `code` | `String` |  |
| `expectedState` | `String` |  |
| `expectedVersion` | `Int` |  |
| `message` | `String` |  |
| `retriable` | `Boolean` |  |

## IncidentPageInfo

| Field | Type | Description |
| --- | --- | --- |
| `endCursor` | `String` |  |
| `hasNextPage` | `Boolean` |  |

## IngestDropshipDeltaPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `deltaCount` | `Int` |  |
| `feedId` | `ID` |  |
| `lastReceivedOn` | `String` |  |
| `levelsCreated` | `Int` |  |
| `levelsUpdated` | `Int` |  |
| `locationId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## IngestDropshipSnapshotPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `feedId` | `ID` |  |
| `lastReceivedOn` | `String` |  |
| `levelsCreated` | `Int` |  |
| `levelsUpdated` | `Int` |  |
| `linesReceived` | `Int` |  |
| `locationId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## InstallOnboardingAgentResult

| Field | Type | Description |
| --- | --- | --- |
| `agentDefinitionRowId` | `ID` |  |
| `commandId` | `ID` |  |
| `installationId` | `ID` |  |
| `mode` | `String` |  |
| `reason` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `success` | `Boolean` |  |

## InventoryCommandPayload

Generic command result for inventory model operator mutations. The command-specific response is carried in `response` and remains validated by the command's zod input/output contract.

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `response` | `JSON` |  |
| `status` | `String` |  |

## InventoryCountLine

| Field | Type | Description |
| --- | --- | --- |
| `countSessionId` | `ID` |  |
| `countedById` | `String` |  |
| `countedByType` | `String` |  |
| `countedOn` | `DateTime` |  |
| `countedQuantity` | `Float` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `exactMatch` | `Boolean` |  |
| `expectedQuantity` | `Float` |  |
| `hitMissClass` | `String` |  |
| `id` | `ID` |  |
| `inventoryLevelId` | `ID` |  |
| `locationId` | `ID` |  |
| `quantityType` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `toleranceClass` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `variance` | `Float` |  |
| `variantId` | `ID` |  |

## InventoryCountSession

| Field | Type | Description |
| --- | --- | --- |
| `closedOn` | `DateTime` |  |
| `countedOn` | `DateTime` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `locationId` | `ID` |  |
| `sessionType` | `String` |  |
| `sourceRef` | `String` |  |
| `sourceSystem` | `String` |  |
| `status` | `String` |  |
| `submittedOn` | `DateTime` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |

## InventoryFutureQuantity

One projected row of inbound supply intent. Walked forward by availability(availableOn:); rebuilt by RecomputeFutureAvailability when a tenant drifts.

| Field | Type | Description |
| --- | --- | --- |
| `confidenceScore` | `Float` |  |
| `environmentId` | `String` |  |
| `expectedOn` | `DateTime` |  |
| `id` | `ID` |  |
| `inventoryLevelId` | `ID` |  |
| `inventoryLotId` | `ID` |  |
| `inventoryOwnerId` | `ID` |  |
| `locationId` | `ID` |  |
| `quantity` | `Float` |  |
| `reasonCode` | `String` |  |
| `resolvedMovementId` | `ID` |  |
| `resolvedOn` | `DateTime` |  |
| `sourceId` | `ID` |  |
| `sourceType` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `variantId` | `ID` |  |
| `version` | `Int` |  |

## InventoryLevel

| Field | Type | Description |
| --- | --- | --- |
| `activeMarkerKeys` | `[String!]` | OPEN workflow-marker keys on this level (ext:&lt;reverse-domain&gt;). Maintained transactionally by AttachWorkflowMarker / ResolveWorkflowMarker. |
| `allocated` | `Float` |  |
| `availableToPromise` | `Float` | onHand - reserved - allocated + incoming - safetyStock - damaged, min 0 |
| `customFields` | `JSON` |  |
| `damaged` | `Float` | Quantity physically on-hand but not sellable due to damage. Excluded from ATP universally. Moved here by MarkInventoryDamaged; moved back by RestoreInventoryFromDamaged. |
| `displayStatus` | `String` | Localized display label composed from (status + activeMarkerKeys) via inventory.extensionTaxonomy.statusFlow.displayMapping. Hot path never reads this; detail views do. |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `incoming` | `Float` |  |
| `inventoryOwnerId` | `ID` |  |
| `locationId` | `ID` |  |
| `onHand` | `Float` |  |
| `reserved` | `Float` |  |
| `safetyStock` | `Float` |  |
| `status` | `String` |  |
| `statusReasonCode` | `String` | Reason supplied with the most recent status transition. May be a platform code (e.g. RECEIVING_DAMAGE) or a tenant ext: identifier. |
| `tenantId` | `String` |  |
| `variantId` | `ID` |  |
| `version` | `Int` |  |

## InventoryLevelStatusTransition

| Field | Type | Description |
| --- | --- | --- |
| `activeMarkerKeysAtTransition` | `[String!]` | Snapshot of OPEN workflow marker keys on the entity at the moment the transition was committed. |
| `actorId` | `String` |  |
| `actorType` | `String` |  |
| `causationId` | `String` |  |
| `correlationId` | `String` |  |
| `entityVersion` | `Int` |  |
| `eventId` | `ID` |  |
| `eventType` | `String` |  |
| `guardsApplied` | `Int` | Count of tenant-declared transition guards that matched this edge. 0 means only the platform's closed-set rule ran. |
| `inventoryLevelId` | `ID` |  |
| `newStatus` | `String` |  |
| `occurredOn` | `DateTime` |  |
| `previousStatus` | `String` |  |
| `reasonCode` | `String` | Reason for the transition. Platform code (e.g. RECEIVING_DAMAGE) or tenant ext: identifier. |

## InventoryMetricsDaily

| Field | Type | Description |
| --- | --- | --- |
| `accuracyRate` | `Float` |  |
| `accuracyRateDenominator` | `Float` |  |
| `accuracyRateNumerator` | `Float` |  |
| `activeVariantLocationHours` | `Float` |  |
| `allocatedEnd` | `Float` |  |
| `atpAvg` | `Float` |  |
| `atpEnd` | `Float` |  |
| `backorderCount` | `Int` |  |
| `computedOn` | `DateTime` |  |
| `countLinesTotal` | `Int` |  |
| `countLinesWithinTolerance` | `Int` |  |
| `countSessionsClosed` | `Int` |  |
| `cycleCountVarianceUnits` | `Float` |  |
| `day` | `String` |  |
| `environmentId` | `String` |  |
| `fillRateUnit` | `Float` |  |
| `fillRateUnitDenominator` | `Float` |  |
| `fillRateUnitNumerator` | `Float` |  |
| `incomingEnd` | `Float` |  |
| `ingestionRecordsCommitted` | `Int` |  |
| `ingestionRecordsRejected` | `Int` |  |
| `movementsByReason` | `JSON` |  |
| `movementsInboundUnits` | `Float` |  |
| `movementsOutboundUnits` | `Float` |  |
| `onHandEnd` | `Float` |  |
| `oosVariantLocationCount` | `Int` |  |
| `orderUnitsFulfilled` | `Float` |  |
| `orderUnitsOrdered` | `Float` |  |
| `oversellUnits` | `Float` |  |
| `positionSampledOn` | `DateTime` |  |
| `reconAgingMaxHours` | `Float` |  |
| `reconDifferencesDecided` | `Int` |  |
| `reconDifferencesDetected` | `Int` |  |
| `reconciliationResolutionRate` | `Float` |  |
| `reconciliationResolutionRateDenominator` | `Float` |  |
| `reconciliationResolutionRateNumerator` | `Float` |  |
| `reservationsCommitted` | `Int` |  |
| `reservationsCreated` | `Int` |  |
| `reservationsExpired` | `Int` |  |
| `reservedEnd` | `Float` |  |
| `rollupCommandId` | `String` |  |
| `rollupEventId` | `String` |  |
| `scope` | `String` |  |
| `sourceCutoff` | `DateTime` |  |
| `stockTransferCycleHoursAvg` | `Float` |  |
| `stockTransfersReceived` | `Int` |  |
| `stockTransfersShipped` | `Int` |  |
| `stockoutHours` | `Float` |  |
| `stockoutRate` | `Float` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## InventoryMetricsLive

| Field | Type | Description |
| --- | --- | --- |
| `activeLevelCount` | `Int` |  |
| `allocatedEnd` | `Float` |  |
| `atpEnd` | `Float` |  |
| `backorderCount` | `Int` |  |
| `computedOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `incomingEnd` | `Float` |  |
| `levelCount` | `Int` |  |
| `onHandEnd` | `Float` |  |
| `oosVariantLocationCount` | `Int` |  |
| `oversellUnits` | `Float` |  |
| `positionSampledOn` | `DateTime` |  |
| `reservedEnd` | `Float` |  |
| `scope` | `String` |  |
| `tenantId` | `String` |  |

## InventoryMetricsTopIssue

| Field | Type | Description |
| --- | --- | --- |
| `benchmarkValue` | `Float` |  |
| `day` | `String` |  |
| `detail` | `String` |  |
| `inventoryLevelId` | `ID` |  |
| `issueType` | `String` |  |
| `locationId` | `ID` |  |
| `metricName` | `String` |  |
| `metricValue` | `Float` |  |
| `observedOn` | `DateTime` |  |
| `scope` | `String` |  |
| `score` | `Float` |  |
| `severity` | `String` |  |
| `variantId` | `ID` |  |

## InventoryMovement

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `String` |  |
| `createdBy` | `String` |  |
| `customFields` | `JSON` |  |
| `delta` | `Float` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `inventoryLevelId` | `ID` |  |
| `occurredOn` | `DateTime` |  |
| `quantityType` | `String` |  |
| `reasonCode` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |

## InventoryReconciliationDecision

| Field | Type | Description |
| --- | --- | --- |
| `appliedOn` | `DateTime` |  |
| `commandId` | `ID` |  |
| `createdOn` | `DateTime` |  |
| `decidedById` | `String` |  |
| `decidedByType` | `String` |  |
| `decidedOn` | `DateTime` |  |
| `decisionReason` | `String` |  |
| `decisionType` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `reconciliationDifferenceId` | `ID` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |

## InventoryReconciliationDifference

| Field | Type | Description |
| --- | --- | --- |
| `countLineId` | `ID` |  |
| `createdOn` | `DateTime` |  |
| `detectedOn` | `DateTime` |  |
| `differenceReason` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `ingestionRecordId` | `ID` |  |
| `inventoryLevelId` | `ID` |  |
| `inventoryLotId` | `ID` |  |
| `inventorySerialId` | `ID` |  |
| `locationId` | `ID` |  |
| `quantityType` | `String` |  |
| `reconciliationSessionId` | `ID` |  |
| `sourceEntityKey` | `JSON` |  |
| `sourceValue` | `Float` |  |
| `status` | `String` |  |
| `systemValue` | `Float` |  |
| `tenantId` | `String` |  |
| `thresholdClass` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `variance` | `Float` |  |
| `variantId` | `ID` |  |

## InventoryReconciliationSession

| Field | Type | Description |
| --- | --- | --- |
| `authorityMode` | `String` |  |
| `comparedScope` | `JSON` |  |
| `completedOn` | `DateTime` |  |
| `countSessionId` | `ID` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `ingestionRunId` | `ID` |  |
| `sourceSystem` | `String` |  |
| `sourceType` | `String` |  |
| `startedOn` | `DateTime` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `thresholdPolicyRef` | `String` |  |
| `updatedOn` | `DateTime` |  |

## InventorySnapshot

| Field | Type | Description |
| --- | --- | --- |
| `freshness` | `ReadFreshness!` |  |
| `locationId` | `ID!` |  |
| `topVariants` | `[InventorySnapshotTopVariant!]!` |  |
| `totals` | `InventorySnapshotTotals!` |  |

## InventorySnapshotTopVariant

| Field | Type | Description |
| --- | --- | --- |
| `allocated` | `Float!` |  |
| `availableToPromise` | `Float!` |  |
| `damaged` | `Float!` |  |
| `onHand` | `Float!` |  |
| `reserved` | `Float!` |  |
| `sku` | `String!` |  |
| `variantId` | `ID!` |  |

## InventorySnapshotTotals

| Field | Type | Description |
| --- | --- | --- |
| `allocatable` | `Float!` |  |
| `allocated` | `Float!` |  |
| `availableToPromise` | `Float!` |  |
| `damaged` | `Float!` |  |
| `incoming` | `Float!` |  |
| `onHand` | `Float!` |  |
| `reserved` | `Float!` |  |
| `safetyStock` | `Float!` |  |

## Job

| Field | Type | Description |
| --- | --- | --- |
| `attempts` | `Int` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `jobType` | `String` |  |
| `maxAttempts` | `Int` |  |
| `payload` | `JSON` |  |
| `result` | `JSON` |  |
| `runAfter` | `DateTime` |  |
| `scheduleId` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |

## JobSchedule

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `jobType` | `String` |  |
| `lastEnqueuedJobId` | `String` |  |
| `lastError` | `String` |  |
| `lastRunOn` | `DateTime` |  |
| `maxAttempts` | `Int` |  |
| `nextRunOn` | `DateTime` |  |
| `payloadTemplate` | `JSON` |  |
| `scheduleConfig` | `JSON` |  |
| `scheduleKey` | `String` |  |
| `scheduleType` | `String` |  |
| `status` | `String` |  |
| `statusReason` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |

## JobScheduleStatusPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `eventId` | `ID` |  |
| `nextRunOn` | `DateTime` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `scheduleId` | `ID` |  |
| `scheduleKey` | `String` |  |
| `status` | `String` |  |

## LabelShipmentPayload

| Field | Type | Description |
| --- | --- | --- |
| `carrier` | `String` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `fulfillmentOrderId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `serviceLevel` | `String` |  |
| `shipmentId` | `ID` |  |
| `status` | `String` |  |
| `trackingRef` | `String` |  |

## Location

| Field | Type | Description |
| --- | --- | --- |
| `addressLine1` | `String` |  |
| `addressLine2` | `String` |  |
| `capabilities` | `LocationCapabilities` |  |
| `capacityPallets` | `Int` |  |
| `capacitySqFt` | `Int` |  |
| `capacityUnits` | `Int` |  |
| `city` | `String` |  |
| `closedOn` | `DateTime` |  |
| `contactPartyId` | `ID` |  |
| `country` | `String` |  |
| `customFields` | `JSON` |  |
| `decommissionedOn` | `DateTime` |  |
| `email` | `String` |  |
| `handlingCutoffLocalTime` | `String` |  |
| `id` | `ID` |  |
| `latitude` | `Float` |  |
| `legacy` | `Boolean` |  |
| `locationRef` | `String` |  |
| `locationType` | `String` |  |
| `longitude` | `Float` |  |
| `name` | `String` |  |
| `openedOn` | `DateTime` |  |
| `operatingExceptions` | `[LocationOperatingException!]` | Calendar-date overrides ordered ascending by exceptionDate. |
| `operatingHours` | `[LocationOperatingHours!]` | Weekly recurring schedule rows ordered by day_of_week then opens_at. |
| `parentLocationId` | `ID` |  |
| `phone` | `String` |  |
| `postalCode` | `String` |  |
| `regionCode` | `String` |  |
| `state` | `String` |  |
| `status` | `String` |  |
| `taxJurisdictionRef` | `String` |  |
| `tenantId` | `String` |  |
| `timeZone` | `String` |  |
| `trustLevel` | `String` |  |
| `version` | `Int` |  |

## LocationCapabilities

Boolean capability flags surfaced as a grouped object so operator UIs and routing engines can read them as a single struct.

| Field | Type | Description |
| --- | --- | --- |
| `alcoholLicensed` | `Boolean` |  |
| `coldChain` | `Boolean` |  |
| `crossDockCapable` | `Boolean` |  |
| `hazmatCertified` | `Boolean` |  |
| `isReturnDestination` | `Boolean` |  |
| `isTransferDestination` | `Boolean` |  |
| `lotTrackingEnabled` | `Boolean` |  |
| `pickupEnabled` | `Boolean` |  |
| `serialTrackingEnabled` | `Boolean` |  |
| `serviceEnabled` | `Boolean` |  |
| `shipFromStoreEnabled` | `Boolean` |  |
| `temperatureControlled` | `Boolean` |  |

## LocationOperatingException

| Field | Type | Description |
| --- | --- | --- |
| `closesAt` | `String` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `exceptionDate` | `String` |  |
| `id` | `ID` |  |
| `isClosed` | `Boolean` |  |
| `locationId` | `ID` |  |
| `opensAt` | `String` |  |
| `reason` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## LocationOperatingHours

| Field | Type | Description |
| --- | --- | --- |
| `closesAt` | `String` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `customFields` | `JSON` |  |
| `dayOfWeek` | `Int` |  |
| `effectiveFrom` | `String` |  |
| `effectiveTo` | `String` |  |
| `id` | `ID` |  |
| `isClosed` | `Boolean` |  |
| `locationId` | `ID` |  |
| `opensAt` | `String` |  |
| `shiftLabel` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## LotAllocationPreview

| Field | Type | Description |
| --- | --- | --- |
| `consideredLots` | `[LotAllocationPreviewConsidered!]` |  |
| `environmentId` | `String` |  |
| `locationId` | `ID` |  |
| `picks` | `[LotAllocationPreviewPick!]` |  |
| `quantity` | `Float` |  |
| `strategy` | `String` |  |
| `tenantId` | `String` |  |
| `totalPickedQuantity` | `Float` |  |
| `variantId` | `ID` |  |

## LotAllocationPreviewConsidered

| Field | Type | Description |
| --- | --- | --- |
| `lotId` | `ID` |  |
| `skippedReason` | `String` |  |

## LotAllocationPreviewPick

| Field | Type | Description |
| --- | --- | --- |
| `lotAllocationPolicyId` | `String` |  |
| `lotId` | `ID` |  |
| `quantity` | `Float` |  |

## LotPiece

| Field | Type | Description |
| --- | --- | --- |
| `lotId` | `ID` |  |
| `quantity` | `Float` |  |

## LotRebuildCorrection

| Field | Type | Description |
| --- | --- | --- |
| `delta` | `Float` |  |
| `lotId` | `ID` |  |
| `previousOnHand` | `Float` |  |
| `rebuiltOnHand` | `Float` |  |

## MarkInventoryDamagedPayload

| Field | Type | Description |
| --- | --- | --- |
| `availableToPromise` | `String` |  |
| `commandId` | `ID` |  |
| `damagedQuantity` | `String` |  |
| `eventId` | `String` |  |
| `inventoryLevelId` | `ID` |  |
| `newVersion` | `Int` |  |
| `onHand` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## MarkReturnInTransitPayload

| Field | Type | Description |
| --- | --- | --- |
| `carrierRef` | `String` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `returnId` | `ID` |  |
| `status` | `String` |  |
| `trackingRef` | `String` |  |

## MetricDefinitionValue

| Field | Type | Description |
| --- | --- | --- |
| `bandCritical` | `Float` |  |
| `bandGood` | `Float` |  |
| `bandWarning` | `Float` |  |
| `bucketStart` | `DateTime` |  |
| `denominator` | `Float` |  |
| `denominatorColumn` | `String` |  |
| `description` | `String` |  |
| `granularity` | `String` |  |
| `lane` | `String` |  |
| `metricKey` | `String` |  |
| `numerator` | `Float` |  |
| `numeratorColumn` | `String` |  |
| `owner` | `String` |  |
| `provider` | `String` |  |
| `scope` | `String` |  |
| `sloRef` | `String` |  |
| `sloTarget` | `Float` |  |
| `title` | `String` |  |
| `value` | `Float` |  |

## MuteAnalyticsAlertResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `muteUntil` | `String` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `ruleId` | `ID` |  |
| `ruleKey` | `String` |  |
| `scope` | `AnalyticsAlertScope` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## NetworkAvailability

Composed network availability answer for a single variant. Walks the six-layer derivation tree: node position, stock segment, node availability, network sum, channel suppression, and optional composite position (substitutes).

| Field | Type | Description |
| --- | --- | --- |
| `appliedPool` | `AccountPoolClamp` |  |
| `byNode` | `[NetworkBucketBreakdown!]` |  |
| `computedOn` | `String` | ISO timestamp of the resolver read. |
| `freshness` | `NetworkFreshness` |  |
| `futureSegments` | `[FutureAvailabilitySegment!]` |  |
| `listingStatus` | `String` | Channel listing status after suppression check (null when no channelId). |
| `networkAtp` | `Float` | networkAvailable plus projected incoming quantity when availableOn is supplied. |
| `networkAvailable` | `Float` | Sum of nodeAvailable across all eligible active nodes. |
| `scope` | `NetworkAvailabilityScope` |  |
| `substituteContribution` | `Float` | Additional available quantity from substitute variants (when requested). |
| `variantId` | `ID` |  |

## NetworkAvailabilityScope

Scope parameters applied to this network availability read.

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `String` |  |
| `environmentId` | `String` |  |
| `locationGroupId` | `String` |  |
| `marketId` | `String` |  |
| `tenantId` | `String` |  |

## NetworkBucketBreakdown

Per-node inventory bucket breakdown including the optional damaged bucket.

| Field | Type | Description |
| --- | --- | --- |
| `allocated` | `Float` |  |
| `damaged` | `Float` |  |
| `incoming` | `Float` |  |
| `inventoryOwnerId` | `ID` |  |
| `isActive` | `Boolean` |  |
| `isDropship` | `Boolean` |  |
| `locationId` | `ID` |  |
| `nodeAtp` | `Float` |  |
| `nodeAvailable` | `Float` |  |
| `onHand` | `Float` |  |
| `reserved` | `Float` |  |
| `safetyStock` | `Float` |  |

## NetworkFreshness

Freshness envelope for the network availability read.

| Field | Type | Description |
| --- | --- | --- |
| `maxLagSeconds` | `Int` |  |
| `source` | `String` |  |

## OnboardingProgressView

| Field | Type | Description |
| --- | --- | --- |
| `ahaFiredAt` | `DateTime` |  |
| `completedAt` | `DateTime` |  |
| `completedSteps` | `[String!]` |  |
| `currentStep` | `String` |  |
| `percentComplete` | `Int` |  |
| `persona` | `String` |  |
| `skippedSteps` | `[String!]` |  |
| `startedAt` | `DateTime` |  |
| `version` | `Int` |  |

## Order

| Field | Type | Description |
| --- | --- | --- |
| `cancelledOn` | `DateTime` |  |
| `channelId` | `String` |  |
| `closedOn` | `DateTime` |  |
| `currency` | `String` |  |
| `customFields` | `JSON` |  |
| `displayId` | `String` |  |
| `environmentId` | `String` |  |
| `financialStatus` | `String` |  |
| `fulfillmentStatus` | `String` |  |
| `id` | `ID` |  |
| `orderNumber` | `BigInt` |  |
| `orderRef` | `String` |  |
| `partyId` | `String` |  |
| `presentmentCurrency` | `String` |  |
| `processedOn` | `DateTime` |  |
| `sourceName` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `totalMinor` | `BigInt` |  |
| `version` | `Int` |  |

## OrderDiscount

| Field | Type | Description |
| --- | --- | --- |
| `allocationMethod` | `String` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `currency` | `String` |  |
| `discountCode` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `orderId` | `ID` |  |
| `targetType` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `valueMinor` | `BigInt` |  |
| `valueType` | `String` |  |
| `version` | `Int` |  |

## OrderLine

| Field | Type | Description |
| --- | --- | --- |
| `allocatedQty` | `Float` |  |
| `createdBy` | `String` |  |
| `customFields` | `JSON` |  |
| `environmentId` | `String` |  |
| `fulfillableQty` | `Float` |  |
| `fulfilledQty` | `Float` |  |
| `id` | `ID` |  |
| `isGiftCard` | `Boolean` |  |
| `orderId` | `ID` |  |
| `orderedQty` | `Float` |  |
| `requiresShipping` | `Boolean` |  |
| `reservedQty` | `Float` |  |
| `sku` | `String` |  |
| `status` | `String` |  |
| `taxable` | `Boolean` |  |
| `tenantId` | `String` |  |
| `totalDiscountMinor` | `BigInt` |  |
| `totalPriceMinor` | `BigInt` |  |
| `unitPriceMinor` | `BigInt` |  |
| `updatedBy` | `String` |  |
| `variantId` | `ID` |  |
| `vendorId` | `ID` |  |

## OrderLineDiscount

| Field | Type | Description |
| --- | --- | --- |
| `amountMinor` | `BigInt` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `currency` | `String` |  |
| `discountCode` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `orderLineId` | `ID` |  |
| `reason` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## OrderLineProperty

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `orderLineId` | `ID` |  |
| `propertyKey` | `String` |  |
| `propertyValue` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## OrderLineTaxLine

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `currency` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `jurisdiction` | `String` |  |
| `orderLineId` | `ID` |  |
| `taxAmountMinor` | `BigInt` |  |
| `taxRate` | `Float` |  |
| `taxTitle` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## OrderLookupFulfillmentOrder

| Field | Type | Description |
| --- | --- | --- |
| `allocatedOn` | `DateTime` |  |
| `cancelledOn` | `DateTime` |  |
| `createdOn` | `DateTime!` |  |
| `fulfilledOn` | `DateTime` |  |
| `fulfillmentOrderId` | `ID!` |  |
| `fulfillmentRef` | `String` |  |
| `lines` | `[OrderLookupFulfillmentOrderLine!]!` |  |
| `packedOn` | `DateTime` |  |
| `pickingStartedOn` | `DateTime` |  |
| `plannedDispatchOn` | `DateTime` |  |
| `priority` | `Int!` |  |
| `sourceLocationId` | `String` |  |
| `status` | `String!` |  |
| `updatedOn` | `DateTime!` |  |
| `version` | `Int!` |  |

## OrderLookupFulfillmentOrderLine

| Field | Type | Description |
| --- | --- | --- |
| `cancelledQty` | `Float!` |  |
| `fulfilledQty` | `Float!` |  |
| `fulfillmentOrderLineId` | `ID!` |  |
| `orderLineId` | `ID!` |  |
| `packedQty` | `Float!` |  |
| `pickedQty` | `Float!` |  |
| `plannedQty` | `Float!` |  |
| `status` | `String!` |  |
| `variantId` | `ID!` |  |
| `version` | `Int!` |  |

## OrderLookupOrder

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `String` |  |
| `createdOn` | `DateTime!` |  |
| `currency` | `String` |  |
| `orderId` | `ID!` |  |
| `orderRef` | `String!` |  |
| `partyId` | `String` |  |
| `status` | `String!` |  |
| `totalMinor` | `BigInt` |  |
| `updatedOn` | `DateTime!` |  |
| `version` | `Int!` |  |

## OrderLookupOrderLine

| Field | Type | Description |
| --- | --- | --- |
| `allocatedQty` | `Float!` |  |
| `createdOn` | `DateTime!` |  |
| `fulfilledQty` | `Float!` |  |
| `orderLineId` | `ID!` |  |
| `orderedQty` | `Float!` |  |
| `reservedQty` | `Float!` |  |
| `sku` | `String!` |  |
| `status` | `String!` |  |
| `updatedOn` | `DateTime!` |  |
| `variantId` | `ID!` |  |

## OrderLookupResult

| Field | Type | Description |
| --- | --- | --- |
| `freshness` | `ReadFreshness!` |  |
| `fulfillmentOrders` | `[OrderLookupFulfillmentOrder!]!` |  |
| `order` | `OrderLookupOrder!` |  |
| `orderLines` | `[OrderLookupOrderLine!]!` |  |
| `shipments` | `[OrderLookupShipment!]!` |  |

## OrderLookupShipment

| Field | Type | Description |
| --- | --- | --- |
| `carrier` | `String` |  |
| `createdOn` | `DateTime!` |  |
| `deliveredOn` | `DateTime` |  |
| `dispatchedOn` | `DateTime` |  |
| `expectedDeliveryOn` | `DateTime` |  |
| `fromLocationId` | `String` |  |
| `lines` | `[OrderLookupShipmentLine!]!` |  |
| `recentEvents` | `[OrderLookupShipmentEvent!]!` |  |
| `shipmentId` | `ID!` |  |
| `status` | `String!` |  |
| `trackingRef` | `String` |  |
| `trackingUrl` | `String` |  |
| `updatedOn` | `DateTime!` |  |

## OrderLookupShipmentEvent

| Field | Type | Description |
| --- | --- | --- |
| `eventId` | `ID!` |  |
| `eventType` | `String!` |  |
| `occurredOn` | `DateTime!` |  |
| `payloadSummary` | `JSON!` |  |
| `streamKey` | `String!` |  |
| `streamSequence` | `String!` |  |

## OrderLookupShipmentLine

| Field | Type | Description |
| --- | --- | --- |
| `fulfillmentOrderLineId` | `ID!` |  |
| `orderLineId` | `ID` |  |
| `packageRef` | `String` |  |
| `quantity` | `Float!` |  |
| `shipmentLineId` | `ID!` |  |
| `status` | `String!` |  |
| `variantId` | `ID!` |  |

## OrderNote

| Field | Type | Description |
| --- | --- | --- |
| `attributes` | `JSON` |  |
| `body` | `String` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `noteType` | `String` |  |
| `orderId` | `ID` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## Party

| Field | Type | Description |
| --- | --- | --- |
| `acceptsMarketing` | `Boolean` |  |
| `archivedOn` | `DateTime` |  |
| `createdOn` | `DateTime` |  |
| `currency` | `String` |  |
| `displayName` | `String` |  |
| `environmentId` | `String` |  |
| `erasedOn` | `DateTime` |  |
| `id` | `ID` |  |
| `legalName` | `String` |  |
| `locale` | `String` |  |
| `partyType` | `String` |  |
| `status` | `String` |  |
| `taxExempt` | `Boolean` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `verifiedEmail` | `Boolean` |  |
| `version` | `Int` |  |

## PartyRole

| Field | Type | Description |
| --- | --- | --- |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `partyId` | `ID` |  |
| `roleType` | `String` |  |
| `scopeId` | `ID` |  |
| `scopeType` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `validFrom` | `DateTime` |  |
| `validTo` | `DateTime` |  |
| `version` | `Int` |  |

## PauseWebhookSubscriptionPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `webhookSubscriptionId` | `ID` |  |

## Product

| Field | Type | Description |
| --- | --- | --- |
| `environmentId` | `String` |  |
| `handle` | `String` |  |
| `id` | `ID` |  |
| `name` | `String` |  |
| `productRef` | `String` |  |
| `productType` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `vendor` | `String` |  |
| `version` | `Int` |  |

## ProductPublication

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `ID` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `productId` | `ID` |  |
| `publishedOn` | `DateTime` |  |
| `scope` | `String` |  |
| `tenantId` | `String` |  |
| `unpublishedOn` | `DateTime` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## ProductSeo

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `id` | `ID` |  |
| `languageCode` | `String` |  |
| `productId` | `ID` |  |
| `seoDescription` | `String` |  |
| `seoTitle` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## ProductVariant

| Field | Type | Description |
| --- | --- | --- |
| `barcode` | `String` |  |
| `compareAtPriceMinor` | `BigInt` |  |
| `countryOfOrigin` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `productId` | `ID` |  |
| `requiresShipping` | `Boolean` |  |
| `sku` | `String` |  |
| `status` | `String` |  |
| `taxCode` | `String` |  |
| `taxable` | `Boolean` |  |
| `tenantId` | `String` |  |
| `trackingType` | `String` |  |
| `version` | `Int` |  |
| `weightUnit` | `String` |  |
| `weightValue` | `Float` |  |

## ProductVariantDimensions

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `heightValue` | `Float` |  |
| `id` | `ID` |  |
| `lengthUnit` | `String` |  |
| `lengthValue` | `Float` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `variantId` | `ID` |  |
| `version` | `Int` |  |
| `widthValue` | `Float` |  |

## ProductVariantFulfillmentPolicy

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `inventoryManagement` | `String` |  |
| `inventoryPolicy` | `String` |  |
| `locationId` | `ID` |  |
| `oversellThresholdPct` | `Float` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `variantId` | `ID` |  |
| `version` | `Int` |  |

## ProgressiveAction

| Field | Type | Description |
| --- | --- | --- |
| `actionKind` | `String` |  |
| `approvalRequestId` | `ID` |  |
| `approverActorId` | `String` |  |
| `approverActorType` | `String` |  |
| `causationId` | `String` |  |
| `commandReceiptId` | `ID` |  |
| `commandType` | `String` |  |
| `correlationId` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `executionResult` | `JSON` |  |
| `expiresAt` | `DateTime` |  |
| `id` | `ID` |  |
| `metadata` | `JSON` |  |
| `moduleSlot` | `String` |  |
| `previewResult` | `JSON` |  |
| `proposalPayload` | `JSON` |  |
| `proposerActorId` | `String` |  |
| `proposerActorType` | `String` |  |
| `riskClass` | `String` |  |
| `skillId` | `String` |  |
| `skipPreview` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `traceparent` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## ProgressiveActionCommandPayload

| Field | Type | Description |
| --- | --- | --- |
| `action` | `ProgressiveAction` |  |
| `commandId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `response` | `JSON` |  |
| `status` | `String` |  |

## ProgressiveActionStep

| Field | Type | Description |
| --- | --- | --- |
| `actorId` | `String` |  |
| `actorType` | `String` |  |
| `fromStatus` | `String` |  |
| `id` | `ID` |  |
| `metadata` | `JSON` |  |
| `note` | `String` |  |
| `progressiveActionId` | `ID` |  |
| `stepNumber` | `Int` |  |
| `toStatus` | `String` |  |
| `transitionedAt` | `DateTime` |  |

## PromoteTenantConfigPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `promotedKeyCount` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `targetEnvironmentId` | `String` |  |

## PublicationAttempt

| Field | Type | Description |
| --- | --- | --- |
| `attempts` | `Int` |  |
| `deliveredOn` | `DateTime` |  |
| `entityId` | `String` |  |
| `entityType` | `String` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `freshnessDeadlineOn` | `DateTime` |  |
| `freshnessStatus` | `String` |  |
| `id` | `ID` |  |
| `lastAttemptOn` | `DateTime` |  |
| `lastError` | `String` |  |
| `priority` | `String` |  |
| `requestedOn` | `DateTime` |  |
| `status` | `String` |  |
| `targetRef` | `String` |  |
| `targetSystem` | `String` |  |
| `tenantId` | `String` |  |

## PublishChannelListingPayload

| Field | Type | Description |
| --- | --- | --- |
| `environmentId` | `String` |  |
| `listingId` | `ID` |  |
| `newVersion` | `Int` |  |
| `priorStatus` | `String` |  |
| `publishedOn` | `String` |  |

## ReadFreshness

| Field | Type | Description |
| --- | --- | --- |
| `computedOn` | `DateTime!` |  |
| `maxLagSeconds` | `Int!` |  |
| `observedOn` | `DateTime!` |  |
| `source` | `String!` |  |

## ReallocateReservationLotPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `newPieces` | `[LotPiece!]` |  |
| `previousPieces` | `[LotPiece!]` |  |
| `replayed` | `Boolean` |  |
| `reservationId` | `ID` |  |
| `reservationVersion` | `Int` |  |
| `status` | `String` |  |

## RebuildChannelAvailabilityPayload

| Field | Type | Description |
| --- | --- | --- |
| `environmentId` | `String` |  |
| `jobId` | `ID` |  |
| `scopeId` | `String` |  |
| `scopeKind` | `String` |  |

## RebuildLotsFromLedgerPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `corrections` | `[LotRebuildCorrection!]` |  |
| `eventId` | `ID` |  |
| `inventoryLevelId` | `ID` |  |
| `lotsScanned` | `Int` |  |
| `lotsUpdated` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## ReceiveStockTransferPayload

| Field | Type | Description |
| --- | --- | --- |
| `channelAvailabilityUpdates` | `Int` |  |
| `commandId` | `ID` |  |
| `newVersion` | `Int` |  |
| `receivedQuantity` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `stockTransferId` | `ID` |  |

## RecomputeFutureAvailabilityResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `locationId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `rowsObserved` | `Int` |  |
| `scopeKey` | `String` |  |
| `status` | `String` |  |
| `variantId` | `ID` |  |

## RecordAppUserSessionHeartbeatPayload

| Field | Type | Description |
| --- | --- | --- |
| `appId` | `String` |  |
| `appInstallationId` | `ID` |  |
| `appSurface` | `String` |  |
| `appUserSessionId` | `ID` |  |
| `commandId` | `ID` |  |
| `commandStatus` | `String` |  |
| `deviceType` | `String` |  |
| `eventId` | `ID` |  |
| `hitCount` | `Int` |  |
| `lastSeenOn` | `String` |  |
| `replayed` | `Boolean` |  |
| `startedOn` | `String` |  |
| `status` | `String` |  |
| `userId` | `ID` |  |
| `version` | `Int` |  |
| `webSessionId` | `ID` |  |

## RecordCountLinePayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `countLineId` | `ID` |  |
| `countedQuantity` | `Int` |  |
| `eventId` | `ID` |  |
| `exactMatch` | `Boolean` |  |
| `expectedQuantity` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `variance` | `Int` |  |

## RefundLineItem

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `currency` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `orderLineId` | `ID` |  |
| `quantity` | `Float` |  |
| `refundId` | `ID` |  |
| `restockQty` | `Float` |  |
| `restockType` | `String` |  |
| `subtotalMinor` | `BigInt` |  |
| `tenantId` | `String` |  |
| `totalTaxMinor` | `BigInt` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## RejectReturnPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `rejectedOn` | `String` |  |
| `rejectionReason` | `String` |  |
| `replayed` | `Boolean` |  |
| `returnId` | `ID` |  |
| `status` | `String` |  |

## ReleaseBundleReservationResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `groupId` | `ID` |  |
| `groupStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousVersion` | `Int` |  |
| `releasedMemberCount` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## ReleaseReservationPayload

| Field | Type | Description |
| --- | --- | --- |
| `availableToPromise` | `String` |  |
| `channelAvailabilityUpdates` | `Int` |  |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `reservationId` | `ID` |  |
| `status` | `String` |  |

## RemoveSubstituteMemberPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `groupId` | `ID` |  |
| `memberId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## ReplayWebhookDeliveryPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `currentAttempts` | `Int` |  |
| `currentStatus` | `String` |  |
| `nextAttemptOn` | `DateTime` |  |
| `previousAttempts` | `Int` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `webhookDeliveryId` | `ID` |  |

## RequestApprovalPayload

| Field | Type | Description |
| --- | --- | --- |
| `approvalRequestId` | `ID` |  |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## Reservation

| Field | Type | Description |
| --- | --- | --- |
| `environmentId` | `String` |  |
| `expiresOn` | `DateTime` |  |
| `id` | `ID` |  |
| `inventoryBinId` | `ID` |  |
| `inventoryLevelId` | `ID` |  |
| `inventoryLotId` | `ID` |  |
| `inventoryOwnerId` | `ID` |  |
| `inventorySerialId` | `ID` |  |
| `locationId` | `ID` |  |
| `lotPieces` | `[LotPiece!]` |  |
| `quantity` | `Float` |  |
| `referenceId` | `String` |  |
| `referenceType` | `String` |  |
| `reservationType` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `variantId` | `ID` |  |
| `version` | `Int` |  |

## ReserveBundleMember

| Field | Type | Description |
| --- | --- | --- |
| `bundleComponentId` | `ID` |  |
| `componentReservationId` | `ID` |  |
| `componentType` | `String` |  |
| `reservationGroupMemberId` | `ID` |  |
| `status` | `String` |  |

## ReserveBundleResult

| Field | Type | Description |
| --- | --- | --- |
| `bundleId` | `ID` |  |
| `commandId` | `ID` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `expiresOn` | `String` |  |
| `groupId` | `ID` |  |
| `groupStatus` | `String` |  |
| `members` | `[ReserveBundleMember!]` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## ResetOnboardingResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `currentStep` | `String` |  |
| `eventId` | `ID` |  |
| `previousStep` | `String` |  |
| `progress` | `OnboardingProgressView` |  |
| `progressId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `version` | `Int` |  |

## ResolveApprovalPayload

| Field | Type | Description |
| --- | --- | --- |
| `approvalRequestId` | `ID` |  |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `eventId` | `ID` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## ResolvedChannelAssignment

| Field | Type | Description |
| --- | --- | --- |
| `assignmentId` | `String` |  |
| `assignmentKey` | `String` |  |
| `businessUnitId` | `String` |  |
| `checkedScopeKinds` | `[String!]` |  |
| `commerceMarketId` | `String` |  |
| `eligibilityProfileId` | `String` |  |
| `fulfillmentNetworkId` | `String` |  |
| `matchedScopeKind` | `String` |  |
| `salesChannelId` | `String` |  |
| `scopeKind` | `String` |  |

## ResolvedOffer

| Field | Type | Description |
| --- | --- | --- |
| `compareAtPriceMinor` | `Int` |  |
| `currency` | `String` |  |
| `effectiveFrom` | `String` |  |
| `effectiveTo` | `String` |  |
| `listingId` | `String` |  |
| `offerId` | `ID` |  |
| `priceListId` | `String` |  |
| `priceMinor` | `Int` |  |
| `version` | `Int` |  |

## ResolveExternalTaskPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `eventId` | `ID` |  |
| `externalTaskId` | `ID` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## ResolveReconciliationDifferencePayload

| Field | Type | Description |
| --- | --- | --- |
| `adjustmentEventId` | `ID` |  |
| `appliedOn` | `String` |  |
| `channelAvailabilityUpdates` | `Int` |  |
| `commandId` | `ID` |  |
| `decisionEventId` | `ID` |  |
| `decisionStatus` | `String` |  |
| `decisionType` | `String` |  |
| `differenceStatus` | `String` |  |
| `inventoryLevelId` | `ID` |  |
| `movementId` | `ID` |  |
| `reconciliationDecisionId` | `ID` |  |
| `reconciliationDifferenceId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## ResolveReturnPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `currency` | `String` |  |
| `eventId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `refundMinor` | `Int` |  |
| `replayed` | `Boolean` |  |
| `resolution` | `String` |  |
| `resolvedOn` | `String` |  |
| `returnId` | `ID` |  |
| `status` | `String` |  |

## RestoreInventoryFromDamagedPayload

| Field | Type | Description |
| --- | --- | --- |
| `availableToPromise` | `String` |  |
| `commandId` | `ID` |  |
| `damagedQuantity` | `String` |  |
| `eventId` | `String` |  |
| `inventoryLevelId` | `ID` |  |
| `newVersion` | `Int` |  |
| `onHand` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## ResumeWebhookSubscriptionPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `currentStatus` | `String` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `webhookSubscriptionId` | `ID` |  |

## RetireBusinessUnitPayload

| Field | Type | Description |
| --- | --- | --- |
| `businessUnitId` | `ID` |  |
| `environmentId` | `String` |  |
| `priorVersion` | `Int` |  |
| `unitKey` | `String` |  |

## RetireChannelAssignmentPayload

| Field | Type | Description |
| --- | --- | --- |
| `assignmentId` | `ID` |  |
| `assignmentKey` | `String` |  |
| `environmentId` | `String` |  |
| `priorVersion` | `Int` |  |
| `scopeKind` | `String` |  |

## RetireCommerceMarketPayload

| Field | Type | Description |
| --- | --- | --- |
| `environmentId` | `String` |  |
| `marketId` | `ID` |  |
| `marketKey` | `String` |  |
| `priorVersion` | `Int` |  |

## RetireSubstituteGroupPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `groupId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## Return

| Field | Type | Description |
| --- | --- | --- |
| `authorizedOn` | `DateTime` |  |
| `createdOn` | `DateTime` |  |
| `currency` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `orderId` | `ID` |  |
| `reasonCode` | `String` |  |
| `receivedOn` | `DateTime` |  |
| `refundMinor` | `Int` |  |
| `rejectedOn` | `DateTime` |  |
| `requestedOn` | `DateTime` |  |
| `resolution` | `String` |  |
| `resolvedOn` | `DateTime` |  |
| `returnRef` | `String` |  |
| `returnToAddressId` | `ID` |  |
| `returnToLocationId` | `ID` |  |
| `returnerPartyId` | `ID` |  |
| `sourceSystem` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## ReturnStatusPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `eventId` | `ID` |  |
| `newStatus` | `String` |  |
| `newVersion` | `Int` |  |
| `previousStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `returnId` | `ID` |  |
| `status` | `String` |  |

## RotateWebhookSubscriptionSecretPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `previousSigningSecretExpiresOn` | `String` |  |
| `previousSigningSecretVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `signingSecret` | `String` |  |
| `signingSecretVersion` | `Int` |  |
| `status` | `String` |  |
| `webhookSubscriptionId` | `ID` |  |

## SalesChannel

| Field | Type | Description |
| --- | --- | --- |
| `channelKey` | `String` |  |
| `channelType` | `String` |  |
| `country` | `String` |  |
| `createdBy` | `String` |  |
| `currency` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |

## SaveAnalyticsReportDefinitionResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `createdOn` | `DateTime` |  |
| `displayName` | `String` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `reportKey` | `String` |  |
| `savedReportId` | `ID` |  |
| `status` | `String` |  |
| `surface` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## SavedReport

Persisted analytics filter view for a tenant operator. Mirrors the saved_report row. The request blob carries the same shape consumed by SaveAnalyticsReportDefinition.

| Field | Type | Description |
| --- | --- | --- |
| `createdOn` | `DateTime` |  |
| `displayName` | `String` |  |
| `environmentId` | `String` |  |
| `reportKey` | `String` |  |
| `request` | `JSON` |  |
| `savedReportId` | `ID` |  |
| `status` | `String` |  |
| `surface` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## SeedSampleInventoryResult

| Field | Type | Description |
| --- | --- | --- |
| `channelAvailabilitiesCreated` | `Int` |  |
| `channelsCreated` | `Int` |  |
| `commandId` | `ID` |  |
| `dryRun` | `Boolean` |  |
| `inventoryLevelsCreated` | `Int` |  |
| `locationsCreated` | `Int` |  |
| `movementsRecorded` | `Int` |  |
| `ownersCreated` | `Int` |  |
| `productsCreated` | `Int` |  |
| `replayed` | `Boolean` |  |
| `scenarioId` | `String` |  |
| `status` | `String` |  |
| `variantsCreated` | `Int` |  |

## SendAdminBroadcastPayload

| Field | Type | Description |
| --- | --- | --- |
| `actionLabel` | `String` |  |
| `actionPayload` | `JSON` |  |
| `actionRouteRef` | `String` |  |
| `actionUrl` | `String` |  |
| `broadcastId` | `ID` |  |
| `commandId` | `ID` |  |
| `commandStatus` | `String` |  |
| `contentHash` | `String` |  |
| `deliveryCount` | `Int` |  |
| `eventId` | `ID` |  |
| `expiresOn` | `String` |  |
| `feedBadgeLabel` | `String` |  |
| `feedBadgeTone` | `String` |  |
| `feedCategory` | `String` |  |
| `feedMetadata` | `JSON` |  |
| `publishedOn` | `String` |  |
| `replayed` | `Boolean` |  |
| `severity` | `String` |  |
| `sourceAppInstallationId` | `ID` |  |
| `sourceEventId` | `ID` |  |
| `status` | `String` |  |
| `targetAppInstallationId` | `ID` |  |
| `targetRole` | `String` |  |
| `targetScope` | `String` |  |
| `targetUserId` | `ID` |  |
| `triggerEntityId` | `ID` |  |
| `triggerEntityType` | `String` |  |
| `triggerEventType` | `String` |  |
| `version` | `Int` |  |

## ServerInfo

| Field | Type | Description |
| --- | --- | --- |
| `cliOauthJwks` | `String!` |  |
| `deprecatedCliVersions` | `[String!]!` |  |
| `protocolVersion` | `String!` |  |
| `serverVersion` | `String!` |  |
| `supportedCliRange` | `SupportedCliRange!` |  |

## SetOnboardingPersonaResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `progress` | `OnboardingProgressView` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## Shipment

| Field | Type | Description |
| --- | --- | --- |
| `carrier` | `String` |  |
| `carrierPartyId` | `ID` |  |
| `createdOn` | `DateTime` |  |
| `deliveredOn` | `DateTime` |  |
| `dispatchedOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `expectedDeliveryOn` | `DateTime` |  |
| `failureReason` | `String` |  |
| `fromLocationId` | `ID` |  |
| `fulfillmentOrderId` | `ID` |  |
| `id` | `ID` |  |
| `packageCount` | `Int` |  |
| `serviceLevel` | `String` |  |
| `shipToAddressId` | `ID` |  |
| `shipmentRef` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `trackingRef` | `String` |  |
| `trackingUrl` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |
| `weightGrams` | `Float` |  |

## ShipmentFeedCursor

| Field | Type | Description |
| --- | --- | --- |
| `hasMore` | `Boolean!` |  |
| `next` | `String` |  |

## ShipmentFeedEvent

| Field | Type | Description |
| --- | --- | --- |
| `eventId` | `ID!` |  |
| `eventType` | `String!` |  |
| `occurredOn` | `DateTime!` |  |
| `orderId` | `ID` |  |
| `payloadSummary` | `JSON!` |  |
| `shipmentId` | `ID!` |  |
| `streamKey` | `String!` |  |
| `streamSequence` | `String!` |  |

## ShipmentFeedHighWaterMark

| Field | Type | Description |
| --- | --- | --- |
| `lastEventId` | `String!` |  |
| `observedOn` | `DateTime!` |  |

## ShipmentFeedPage

| Field | Type | Description |
| --- | --- | --- |
| `cursor` | `ShipmentFeedCursor!` |  |
| `events` | `[ShipmentFeedEvent!]!` |  |
| `freshness` | `ReadFreshness!` |  |
| `highWaterMark` | `ShipmentFeedHighWaterMark!` |  |

## ShipStockTransferPayload

| Field | Type | Description |
| --- | --- | --- |
| `channelAvailabilityUpdates` | `Int` |  |
| `commandId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `stockTransferId` | `ID` |  |

## StartCountSessionPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `countSessionId` | `ID` |  |
| `eventId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## StartOnboardingResult

| Field | Type | Description |
| --- | --- | --- |
| `alreadyExisted` | `Boolean` |  |
| `commandId` | `ID` |  |
| `currentStep` | `String` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `progress` | `OnboardingProgressView` |  |
| `progressId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## StockTransfer

| Field | Type | Description |
| --- | --- | --- |
| `environmentId` | `String` |  |
| `fromLocationId` | `ID` |  |
| `id` | `ID` |  |
| `quantity` | `Float` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `toLocationId` | `ID` |  |
| `transferRef` | `String` |  |
| `variantId` | `ID` |  |
| `version` | `Int` |  |

## SubstituteGroup

| Field | Type | Description |
| --- | --- | --- |
| `channelId` | `ID` |  |
| `createdOn` | `DateTime` |  |
| `description` | `String` |  |
| `environmentId` | `String` |  |
| `groupKey` | `String` |  |
| `id` | `ID` |  |
| `primaryVariantId` | `ID` |  |
| `priority` | `Int` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `String` |  |

## SubstituteMember

| Field | Type | Description |
| --- | --- | --- |
| `createdOn` | `DateTime` |  |
| `groupId` | `ID` |  |
| `id` | `ID` |  |
| `priority` | `Int` |  |
| `status` | `String` |  |
| `substituteFactor` | `String` |  |
| `substituteVariantId` | `ID` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `String` |  |

## SupportedCliRange

| Field | Type | Description |
| --- | --- | --- |
| `max` | `String!` |  |
| `min` | `String!` |  |

## SuppressChannelListingPayload

| Field | Type | Description |
| --- | --- | --- |
| `environmentId` | `String` |  |
| `listingId` | `ID` |  |
| `newVersion` | `Int` |  |
| `priorStatus` | `String` |  |
| `suppressedReason` | `String` |  |

## TenantConfig

| Field | Type | Description |
| --- | --- | --- |
| `configKey` | `String` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `definition` | `TenantConfigDefinition` |  |
| `description` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `value` | `JSON` |  |
| `version` | `Int` |  |

## TenantConfigDefinition

| Field | Type | Description |
| --- | --- | --- |
| `auditReasonRequired` | `Boolean` |  |
| `defaultValue` | `JSON` |  |
| `description` | `String` |  |
| `exampleValue` | `JSON` |  |
| `extensionSafe` | `Boolean` |  |
| `key` | `String` |  |
| `kind` | `String` |  |
| `lifecycle` | `String` |  |
| `owner` | `String` |  |
| `requiredScopes` | `[String!]` |  |
| `requiresApproval` | `Boolean` |  |
| `runtimeConsumers` | `[String!]` |  |
| `schemaNotes` | `[String!]` |  |
| `scope` | `String` |  |
| `sensitivity` | `String` |  |
| `tags` | `[String!]` |  |
| `title` | `String` |  |
| `visibility` | `[String!]` |  |

## TenantConfigHistory

| Field | Type | Description |
| --- | --- | --- |
| `causationId` | `String` |  |
| `changeReason` | `String` |  |
| `changedById` | `String` |  |
| `changedByType` | `String` |  |
| `changedOn` | `DateTime` |  |
| `commandId` | `ID` |  |
| `configKey` | `String` |  |
| `correlationId` | `String` |  |
| `description` | `String` |  |
| `eventId` | `ID` |  |
| `id` | `ID` |  |
| `previousValue` | `JSON` |  |
| `tenantId` | `String` |  |
| `traceparent` | `String` |  |
| `value` | `JSON` |  |
| `version` | `Int` |  |

## TenantConfigModule

| Field | Type | Description |
| --- | --- | --- |
| `defaultVisibility` | `[String!]` |  |
| `description` | `String` |  |
| `key` | `String` |  |
| `ownerRole` | `String` |  |
| `title` | `String` |  |

## TenantDeployment

| Field | Type | Description |
| --- | --- | --- |
| `archiveStorageRef` | `String` |  |
| `auditLogRef` | `String` |  |
| `backupPolicyRef` | `String` |  |
| `cellId` | `String` |  |
| `databaseRef` | `String` |  |
| `deploymentKey` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `indexRef` | `String` |  |
| `isolationMode` | `String` |  |
| `kmsKeyRef` | `String` |  |
| `lifecycleStage` | `String` |  |
| `logSinkRef` | `String` |  |
| `migrationState` | `JSON` |  |
| `objectStoragePrefix` | `String` |  |
| `objectStorageRef` | `String` |  |
| `queueLaneRef` | `String` |  |
| `readReplicaRef` | `String` |  |
| `region` | `String` |  |
| `routingMetadata` | `JSON` |  |
| `schemaRef` | `String` |  |
| `secretsRef` | `String` |  |
| `status` | `String` |  |
| `storageMode` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |
| `workerPoolRef` | `String` |  |

## TenantEnvironment

| Field | Type | Description |
| --- | --- | --- |
| `activatedOn` | `DateTime` |  |
| `createdOn` | `DateTime` |  |
| `dataClassification` | `String` |  |
| `environmentKey` | `String` |  |
| `environmentType` | `String` |  |
| `id` | `ID` |  |
| `infraClass` | `String` |  |
| `lifecycleStage` | `String` |  |
| `metadata` | `JSON` |  |
| `name` | `String` |  |
| `sourceEnvironmentId` | `String` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## TenantInventoryMetricsBucket

| Field | Type | Description |
| --- | --- | --- |
| `accuracyRate` | `Float` |  |
| `accuracyRateDenominator` | `Float` |  |
| `accuracyRateNumerator` | `Float` |  |
| `activeVariantLocationHours` | `Float` |  |
| `allocatedEnd` | `Float` |  |
| `atpAvg` | `Float` |  |
| `atpEnd` | `Float` |  |
| `avgInventoryValueMinor` | `Float` |  |
| `backorderCount` | `Int` |  |
| `bucketStart` | `DateTime` |  |
| `cogsMinor` | `Float` |  |
| `computedOn` | `DateTime` |  |
| `costCurrency` | `String` |  |
| `countLinesTotal` | `Int` |  |
| `countLinesWithinTolerance` | `Int` |  |
| `countSessionsClosed` | `Int` |  |
| `cycleCountVarianceUnits` | `Float` |  |
| `daysOnHand` | `Float` |  |
| `environmentId` | `String` |  |
| `fillRateUnit` | `Float` |  |
| `fillRateUnitDenominator` | `Float` |  |
| `fillRateUnitNumerator` | `Float` |  |
| `gmroi` | `Float` |  |
| `granularity` | `String` |  |
| `inboundValueMinor` | `Float` |  |
| `incomingEnd` | `Float` |  |
| `ingestionRecordsCommitted` | `Int` |  |
| `ingestionRecordsRejected` | `Int` |  |
| `movementsByReason` | `JSON` |  |
| `movementsInboundUnits` | `Float` |  |
| `movementsOutboundUnits` | `Float` |  |
| `onHandEnd` | `Float` |  |
| `oosVariantLocationCount` | `Int` |  |
| `orderUnitsFulfilled` | `Float` |  |
| `orderUnitsOrdered` | `Float` |  |
| `oversellUnits` | `Float` |  |
| `positionSampledOn` | `DateTime` |  |
| `reconAgingMaxHours` | `Float` |  |
| `reconDifferencesDecided` | `Int` |  |
| `reconDifferencesDetected` | `Int` |  |
| `reconciliationResolutionRate` | `Float` |  |
| `reconciliationResolutionRateDenominator` | `Float` |  |
| `reconciliationResolutionRateNumerator` | `Float` |  |
| `reservationsCommitted` | `Int` |  |
| `reservationsCreated` | `Int` |  |
| `reservationsExpired` | `Int` |  |
| `reservedEnd` | `Float` |  |
| `rollupCommandId` | `String` |  |
| `rollupEventId` | `String` |  |
| `scope` | `String` |  |
| `sourceCutoff` | `DateTime` |  |
| `stockTransferCycleHoursAvg` | `Float` |  |
| `stockTransfersReceived` | `Int` |  |
| `stockTransfersShipped` | `Int` |  |
| `stockoutHours` | `Float` |  |
| `stockoutRate` | `Float` |  |
| `tenantId` | `String` |  |
| `turnoverRatio` | `Float` |  |
| `version` | `Int` |  |

## TenantRealtimeGaugeValue

| Field | Type | Description |
| --- | --- | --- |
| `denominator` | `Float` |  |
| `numerator` | `Float` |  |
| `sourceWatermark` | `DateTime` |  |
| `updatedOn` | `DateTime` |  |
| `value` | `Float` |  |
| `version` | `Int` |  |

## Transaction

| Field | Type | Description |
| --- | --- | --- |
| `amountMinor` | `BigInt` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `currency` | `String` |  |
| `environmentId` | `String` |  |
| `errorCode` | `String` |  |
| `errorMessage` | `String` |  |
| `gateway` | `String` |  |
| `id` | `ID` |  |
| `kind` | `String` |  |
| `parentTransactionId` | `ID` |  |
| `paymentIntentId` | `ID` |  |
| `processedOn` | `DateTime` |  |
| `providerRef` | `String` |  |
| `refundId` | `ID` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |
| `version` | `Int` |  |

## UpdateDropshipFeedPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `feedId` | `ID` |  |
| `locationId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## UpdateLocationPayload

| Field | Type | Description |
| --- | --- | --- |
| `changedFields` | `[String!]` |  |
| `commandId` | `ID` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `locationId` | `ID` |  |
| `locationRef` | `String` |  |
| `locationStatus` | `String` |  |
| `locationType` | `String` |  |
| `name` | `String` |  |
| `newVersion` | `Int` |  |
| `previousVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## UpdateProductResult

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `name` | `String` |  |
| `newVersion` | `Int` |  |
| `previousVersion` | `Int` |  |
| `productId` | `ID` |  |
| `productRef` | `String` |  |
| `productStatus` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## UpdateProductVariantResult

| Field | Type | Description |
| --- | --- | --- |
| `barcode` | `String` |  |
| `commandId` | `ID` |  |
| `defaultShelfLifeDays` | `Int` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `exportControlClass` | `String` |  |
| `hazmatClass` | `String` |  |
| `hsCode` | `String` |  |
| `newVersion` | `Int` |  |
| `optionValues` | `JSON` |  |
| `previousVersion` | `Int` |  |
| `productId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `requiresExpiryTracking` | `Boolean` |  |
| `requiresLotTracking` | `Boolean` |  |
| `requiresSerialTracking` | `Boolean` |  |
| `sku` | `String` |  |
| `status` | `String` |  |
| `temperatureZone` | `String` |  |
| `tenantId` | `String` |  |
| `trackingType` | `String` |  |
| `uom` | `String` |  |
| `variantId` | `ID` |  |
| `variantStatus` | `String` |  |

## UpsertCustomFieldPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `customFieldId` | `ID` |  |
| `entityId` | `ID` |  |
| `entityType` | `String` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `fieldKey` | `String` |  |
| `key` | `String` |  |
| `namespace` | `String` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `version` | `Int` |  |

## UpsertJobSchedulePayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `eventId` | `ID` |  |
| `jobType` | `String` |  |
| `nextRunOn` | `DateTime` |  |
| `replayed` | `Boolean` |  |
| `scheduleId` | `ID` |  |
| `scheduleKey` | `String` |  |
| `scheduleStatus` | `String` |  |
| `status` | `String` |  |

## UpsertLocationOperatingExceptionPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `exceptionDate` | `String` |  |
| `exceptionId` | `ID` |  |
| `isClosed` | `Boolean` |  |
| `locationId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## UpsertLocationOperatingHoursPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `locationId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `rowsRemoved` | `Int` |  |
| `rowsWritten` | `Int` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## UpsertSubstituteGroupPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `environmentId` | `String` |  |
| `groupId` | `ID` |  |
| `groupKey` | `String` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |

## UpsertSubstituteMemberPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `groupId` | `ID` |  |
| `memberId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `substituteVariantId` | `ID` |  |

## UpsertTenantConfigPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `configKey` | `String` |  |
| `created` | `Boolean` |  |
| `eventId` | `ID` |  |
| `newVersion` | `Int` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## UpsertTenantEnvironmentPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `deploymentCreated` | `Boolean` |  |
| `deploymentId` | `ID` |  |
| `deploymentKey` | `String` |  |
| `deploymentVersion` | `Int` |  |
| `environmentCreated` | `Boolean` |  |
| `environmentId` | `String` |  |
| `environmentKey` | `String` |  |
| `environmentType` | `String` |  |
| `environmentVersion` | `Int` |  |
| `eventId` | `ID` |  |
| `replayed` | `Boolean` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |

## UpsertWebhookSubscriptionPayload

| Field | Type | Description |
| --- | --- | --- |
| `commandId` | `ID` |  |
| `created` | `Boolean` |  |
| `replayed` | `Boolean` |  |
| `signingSecret` | `String` |  |
| `signingSecretVersion` | `Int` |  |
| `status` | `String` |  |
| `webhookSubscriptionId` | `ID` |  |

## UsageEvent

| Field | Type | Description |
| --- | --- | --- |
| `attributes` | `JSON` |  |
| `billingExportBatchId` | `String` |  |
| `billingExportStatus` | `String` |  |
| `correlationId` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `idempotencyKey` | `String` |  |
| `meter` | `String` |  |
| `occurredOn` | `DateTime` |  |
| `quantity` | `String` |  |
| `resourceId` | `String` |  |
| `resourceKind` | `String` |  |
| `source` | `String` |  |
| `subjectId` | `String` |  |
| `subjectType` | `String` |  |
| `tenantId` | `String` |  |
| `traceparent` | `String` |  |

## UsageSummary

| Field | Type | Description |
| --- | --- | --- |
| `billingExportStatus` | `String` |  |
| `environmentId` | `String` |  |
| `eventCount` | `Int` |  |
| `meter` | `String` |  |
| `quantity` | `String` |  |
| `tenantId` | `String` |  |

## WebhookDelivery

| Field | Type | Description |
| --- | --- | --- |
| `attempts` | `Int` |  |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `environmentId` | `String` |  |
| `eventId` | `ID` |  |
| `freshnessDeadlineOn` | `DateTime` |  |
| `freshnessStatus` | `String` |  |
| `id` | `ID` |  |
| `lastAttemptOn` | `DateTime` |  |
| `lastError` | `String` |  |
| `nextAttemptOn` | `DateTime` |  |
| `priority` | `String` |  |
| `status` | `String` |  |
| `subscriptionId` | `ID` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |

## WebhookSubscription

| Field | Type | Description |
| --- | --- | --- |
| `createdBy` | `String` |  |
| `createdOn` | `DateTime` |  |
| `deliveryMode` | `String` |  |
| `environmentId` | `String` |  |
| `eventPattern` | `String` |  |
| `id` | `ID` |  |
| `signingSecretRef` | `String` |  |
| `signingSecretRotatedOn` | `DateTime` |  |
| `signingSecretVersion` | `Int` |  |
| `status` | `String` |  |
| `targetUrl` | `String` |  |
| `tenantId` | `String` |  |
| `updatedBy` | `String` |  |
| `updatedOn` | `DateTime` |  |

## WorkflowMarker

| Field | Type | Description |
| --- | --- | --- |
| `createdOn` | `DateTime` |  |
| `entityId` | `ID` |  |
| `entityType` | `String` |  |
| `environmentId` | `String` |  |
| `id` | `ID` |  |
| `markerKey` | `String` |  |
| `markerType` | `String` |  |
| `payload` | `JSON` |  |
| `status` | `String` |  |
| `tenantId` | `String` |  |
| `updatedOn` | `DateTime` |  |