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 \
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 \
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
Privacy choices
This controls app-managed marketing analytics: cookie-free Plausible, optional Cloudflare Web Analytics, and first-party event logs with session-only UTM attribution. The site works without it.