GraphQL input types

Input object types in the KarmanFlow GraphQL schema.

AcknowledgeIncidentInput

FieldTypeDescription
acknowledgedByString!
expectedVersionInt!
incidentIdID!
metadataCommandMetadataInput!
reasonString!
tenantIdString!

ActivateAsShopifyFulfillmentServiceInput

FieldTypeDescription
bindingIdID!
callbackUrlString!
metadataCommandMetadataInput!
shopifyFulfillmentServiceIdInt!
shopifyLocationIdInt!
tenantIdString!

AddShopifyShopInput

FieldTypeDescription
accessTokenSecretRefString!
installedByActorIdString!
metadataCommandMetadataInput!
scope[String!]!
shopDomainString!
tenantIdString!

AdjustInventoryInput

FieldTypeDescription
deltaFloat!
expectedVersionInt!
inventoryLevelIdID!
metadataCommandMetadataInput!
quantityTypeString!ON_HAND \
reasonCodeString
tenantIdString!

AdvanceOnboardingStepInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
nextStepIdString!
stepIdString!
tenantIdString!

AllocateFulfillmentOrderInput

FieldTypeDescription
expectedVersionInt!
fulfillmentOrderIdID!
metadataCommandMetadataInput!
tenantIdString!

AnalyticsExportBucketRangeInput

FieldTypeDescription
bucketTypeString!
fromDateTime!
toDateTime!

AppFeedItemStateInput

FieldTypeDescription
appUserSessionIdString
deliveryIdString!
expectedVersionInt!
metadataCommandMetadataInput!
tenantIdString!
webSessionIdString

ApplyCountVarianceInput

FieldTypeDescription
countLineIdString!
countSessionIdString!
expectedVersionInt!
inventoryLevelIdString!
metadataCommandMetadataInput!
reasonCodeString
tenantIdString!

ApproveProgressiveActionInput

FieldTypeDescription
actionIdID!
approvalIdID
expectedVersionInt!
metadataCommandMetadataInput!
noteString
tenantIdString!

AssignPartyRoleInput

FieldTypeDescription
metadataCommandMetadataInput!
partyIdID!
roleTypeString!
scopeIdID
scopeTypeString!
tenantIdString!
validFromDateTime
validToDateTime

AuthorizeReturnInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
returnIdID!
tenantIdString!

BuildContextPackInput

FieldTypeDescription
entityIdString
entityTypeString
eventLimitInt
localeString

BuildCustomerServiceContextInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
requestIdID!
tenantIdString!

CancelAnalyticsExportInput

FieldTypeDescription
exportIdID!
metadataCommandMetadataInput!
reasonString!
tenantIdString!

CancelFulfillmentOrderInput

FieldTypeDescription
cancellationReasonString
expectedVersionInt!
fulfillmentOrderIdID!
metadataCommandMetadataInput!
tenantIdString!

CancelFutureSupplyInput

FieldTypeDescription
cancellationReasonString!
expectedVersionInt!
futureQuantityIdID!
metadataCommandMetadataInput!
tenantIdString!

CancelJobScheduleInput

FieldTypeDescription
metadataCommandMetadataInput!
reasonString
scheduleIdID!
tenantIdString!

CancelReturnInput

FieldTypeDescription
cancellationReasonString
expectedVersionInt!
metadataCommandMetadataInput!
returnIdID!
tenantIdString!

CancelStockTransferInput

FieldTypeDescription
cancellationReasonString!
expectedVersionInt!
metadataCommandMetadataInput!
stockTransferIdID!
tenantIdString!

CleanupSampleDataInput

FieldTypeDescription
metadataCommandMetadataInput!
tenantIdString!

ClearSampleDataInput

FieldTypeDescription
metadataCommandMetadataInput!
reasonString!
tenantIdString!

CloseCountSessionInput

FieldTypeDescription
actionString!
countSessionIdString!
metadataCommandMetadataInput!
noteString
tenantIdString!

CommandMetadataInput

FieldTypeDescription
actorIdString!
actorTypeString!
causationIdString!
correlationIdString!
idempotencyKeyString!
policyContextJSON
traceparentString

CommitBundleReservationInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
orderIdID!
reservationGroupIdID!
tenantIdString!

CommitReservationInput

FieldTypeDescription
expectedReservationVersionInt!
metadataCommandMetadataInput!
reasonCodeString
reservationIdID!
tenantIdString!

CompleteFulfillmentOrderPackingInput

FieldTypeDescription
expectedVersionInt!
fulfillmentOrderIdID!
metadataCommandMetadataInput!
tenantIdString!

ComponentReservationInput

FieldTypeDescription
acceptBackorderBoolean
bundleComponentIdID!
expectedInventoryLevelVersionInt!
inventoryBinIdID
inventoryLotIdID
inventoryOwnerIdID!
inventorySerialIdID
locationIdID!
referenceIdID
referenceTypeString
reservationTypeString!

ConfigureTenantDefaultsInput

FieldTypeDescription
metadataCommandMetadataInput!
personaString!
tenantIdString!

CreateAddressInput

FieldTypeDescription
cityString
countryCodeString!
kindString!
line1String!
line2String
line3String
metadataCommandMetadataInput!
partyIdID!
postalCodeString
regionString
regionCodeString
tenantIdString!

CreateAnalyticsAlertInput

FieldTypeDescription
channels[String!]
descriptionString
displayNameString!
escalationAfterHoursInt
metadataCommandMetadataInput!
muteUntilString
ruleKeyString!
scopeAnalyticsAlertScope
severityString!
specJSON!
tenantIdString!

CreateContactPointInput

FieldTypeDescription
contactTypeString!
metadataCommandMetadataInput!
partyIdID!
preferredBoolean
preferredLanguageString
preferredLocaleString
tenantIdString!
valueString!
valueNormalizedString

CreateCustomerServiceRequestInput

FieldTypeDescription
addressIdID
channelString!
contactPointIdID
customerPartyIdID
fulfillmentOrderIdID
intentSummaryString!
metadataCommandMetadataInput!
orderIdID
requestClassString!
returnIdID
shipmentIdID
sourceArtifactsJSON
subjectIdID!
subjectTypeString!
tenantIdString!
triggerSourceString!

CreateDropshipLocationInput

FieldTypeDescription
addressLine1String
addressLine2String
cityString
connectorKeyString
countryString
dropshipSupplierPartyIdString!
feedTypeString
locationRefString!
metadataCommandMetadataInput!
nameString!
postalCodeString
regionCodeString
scheduleCronString
stalenessThresholdSecondsInt
stateString
tenantIdString!
timeZoneString

CreateExternalTaskInput

FieldTypeDescription
dueOnDateTime
entityIdString!
entityTypeString!
inputPayloadJSON!
metadataCommandMetadataInput!
targetRefString
targetSystemString!
taskTypeString!
tenantIdString!

CreateFulfillmentOrderInput

FieldTypeDescription
fulfillmentRefString
metadataCommandMetadataInput!
orderIdString!
plannedDispatchOnDateTime
priorityInt
shipToAddressIdString
shipToPartyIdString
sourceLocationIdString
sourceSystemString
tenantIdString!

CreateOrderInput

FieldTypeDescription
channelIdString
currencyString
lines[CreateOrderLineInput!]!
metadataCommandMetadataInput!
orderRefString!
partyIdString
tenantIdString!
totalMinorBigInt

CreateOrderLineInput

FieldTypeDescription
orderedQtyFloat!
reservationIdString
variantIdString!

CreatePartyInput

FieldTypeDescription
displayNameString
externalRefString
familyNameString
givenNameString
legalNameString
metadataCommandMetadataInput!
partyTypeString!
tenantIdString!

CreateProductInput

FieldTypeDescription
metadataCommandMetadataInput!
nameString!
productIdID
productRefString
statusString
tenantIdString!

CreateProductVariantInput

FieldTypeDescription
barcodeString
defaultShelfLifeDaysInt
exportControlClassString
hazmatClassString
hsCodeString
metadataCommandMetadataInput!
optionValuesJSON
productIdID!
requiresExpiryTrackingBoolean
requiresLotTrackingBoolean
requiresSerialTrackingBoolean
skuString!
statusString
temperatureZoneString
tenantIdString!
trackingTypeString
uomString
variantIdID

CreateReservationInput

FieldTypeDescription
expectedInventoryLevelVersionInt!
expiresOnDateTime
inventoryBinIdString
inventoryLotIdString
inventoryOwnerIdString!
inventorySerialIdString
locationIdString!
metadataCommandMetadataInput!
quantityFloat!
referenceIdString
referenceTypeString
reservationTypeString!
tenantIdString!
variantIdString!

CreateReturnInput

FieldTypeDescription
metadataCommandMetadataInput!
orderIdID!
reasonCodeString
returnRefString
returnToAddressIdID
returnToLocationIdID
returnerPartyIdID
sourceSystemString
tenantIdString!

CreateShipmentInput

FieldTypeDescription
carrierString
carrierPartyIdID
expectedDeliveryOnDateTime
expectedFulfillmentOrderVersionInt!
fromLocationIdID
fulfillmentOrderIdID!
lines[CreateShipmentLineInput!]
metadataCommandMetadataInput!
packageCountInt
serviceLevelString
shipToAddressIdID
shipmentRefString
tenantIdString!
trackingRefString
trackingUrlString
weightGramsInt

CreateShipmentLineInput

FieldTypeDescription
fulfillmentOrderLineIdID!
packageRefString
quantityFloat!

CreateStockTransferInput

FieldTypeDescription
carrierString
expectedDeliveryOnDateTime
fromInventoryLevelIdString!
fromLocationIdString!
inventoryOwnerIdString!
metadataCommandMetadataInput!
quantityFloat!
reasonCodeString
shipByOnDateTime
tenantIdString!
toInventoryLevelIdString!
toLocationIdString!
trackingRefString
transferRefString!
variantIdString!

DeactivateAsShopifyFulfillmentServiceInput

FieldTypeDescription
bindingIdID!
metadataCommandMetadataInput!
tenantIdString!

DeactivateChannelOfferInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
offerIdID!
tenantIdString!

DecommissionLocationInput

FieldTypeDescription
closedOnString
decommissionedOnString
expectedVersionInt!
locationIdID!
metadataCommandMetadataInput!
reasonString
tenantIdString!

DeleteAnalyticsAlertInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
ruleKeyString!
scopeAnalyticsAlertScope!
tenantIdString!

DeleteSavedReportInput

FieldTypeDescription
environmentIdString!
expectedVersionInt!
metadataCommandMetadataInput!
reportKeyString!
tenantIdString!

DelistChannelListingInput

FieldTypeDescription
expectedVersionInt!
listingIdID!
metadataCommandMetadataInput!
tenantIdString!

DispatchShipmentInput

FieldTypeDescription
dispatchedOnDateTime
expectedVersionInt!
metadataCommandMetadataInput!
shipmentIdID!
tenantIdString!
trackingRefString
trackingUrlString

DropshipDeltaLineInput

FieldTypeDescription
deltaFloat!
lotRefString
variantIdString!

DropshipInventoryLineInput

FieldTypeDescription
lotRefString
quantityFloat!
variantIdString!

ErasePartyInput

FieldTypeDescription
approvalRequestIdID!
metadataCommandMetadataInput!
partyIdID!
reasonString
tenantIdString!

EscalateCustomerServiceRequestInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
ownerTeamString
reasonString!
requestIdID!
tenantIdString!

EscalateIncidentInput

FieldTypeDescription
expectedVersionInt!
incidentIdID!
metadataCommandMetadataInput!
reasonString!
tenantIdString!

ExecuteIncidentActionInput

FieldTypeDescription
expectedVersionInt!
incidentIdID!
metadataCommandMetadataInput!
resolvedCommandReceiptIdString!
tenantIdString!

ExecuteProgressiveActionInput

FieldTypeDescription
actionIdID!
expectedVersionInt!
metadataCommandMetadataInput!
tenantIdString!

ExpireReservationInput

FieldTypeDescription
expectedReservationVersionInt!
metadataCommandMetadataInput!
reservationIdID!
tenantIdString!

FireAhaMomentScenarioInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
scenarioIdString
tenantIdString!

FulfillFulfillmentOrderInput

FieldTypeDescription
expectedVersionInt!
fulfillmentOrderIdID!
metadataCommandMetadataInput!
tenantIdString!

IgnoreShopifyDriftEventInput

FieldTypeDescription
aggregateTypeString!
bindingIdID!
dismissedReasonString
driftEventIdID!
metadataCommandMetadataInput!
partnerAggregateIdString!
tenantIdString!

IngestDropshipDeltaInput

FieldTypeDescription
feedIdString!
inventoryOwnerKeyString
lines[DropshipDeltaLineInput!]!
metadataCommandMetadataInput!
tenantIdString!

IngestDropshipSnapshotInput

FieldTypeDescription
feedIdString!
inventoryOwnerKeyString
lines[DropshipInventoryLineInput!]!
metadataCommandMetadataInput!
tenantIdString!

InspectReturnInput

FieldTypeDescription
expectedVersionInt!
inspectionNotesString
metadataCommandMetadataInput!
returnIdID!
tenantIdString!

InstallOnboardingAgentInput

FieldTypeDescription
agentDefinitionIdString!
capabilityGrantJSON
metadataCommandMetadataInput!
modeString
tenantIdString!

InventoryCommandJsonInput

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

FieldTypeDescription
metadataCommandMetadataInput!
payloadJSON
tenantIdString!

LabelShipmentInput

FieldTypeDescription
carrierString!
carrierPartyIdID
expectedDeliveryOnDateTime
expectedVersionInt!
metadataCommandMetadataInput!
packageCountInt
serviceLevelString!
shipmentIdID!
tenantIdString!
trackingRefString!
trackingUrlString
weightGramsInt

LocationOperatingHoursEntryInput

FieldTypeDescription
closesAtString!
dayOfWeekInt!
effectiveFromString
effectiveToString
isClosedBoolean
opensAtString!
shiftLabelString

MarkInventoryDamagedInput

FieldTypeDescription
evidenceUriString
expectedVersionInt!
inventoryLevelIdID!
inventoryLotIdID
metadataCommandMetadataInput!
notesString
quantityFloat!
reasonCodeStringAccepted values: DAMAGE, QC_FAIL, EXPIRY, OPERATOR_OVERRIDE. Defaults to DAMAGE.
tenantIdString!

MarkReturnInTransitInput

FieldTypeDescription
carrierRefString
expectedVersionInt!
metadataCommandMetadataInput!
returnIdID!
tenantIdString!
trackingRefString

MuteAnalyticsAlertInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
muteUntilString
ruleKeyString!
scopeAnalyticsAlertScope!
tenantIdString!

PauseJobScheduleInput

FieldTypeDescription
metadataCommandMetadataInput!
reasonString
scheduleIdID!
tenantIdString!

PauseWebhookSubscriptionInput

FieldTypeDescription
metadataCommandMetadataInput!
tenantIdString!
webhookSubscriptionIdID!

PreviewProgressiveActionInput

FieldTypeDescription
actionIdID!
expectedVersionInt!
metadataCommandMetadataInput!
noteString
previewResultJSON!
tenantIdString!

ProcessGdprDataRequestInput

FieldTypeDescription
bindingIdID!
metadataCommandMetadataInput!
partnerCustomerEmailString
partnerCustomerIdString!
partnerOrdersRequested[String!]
receivedOnDateTime!
tenantIdString!

PromoteTenantConfigInput

FieldTypeDescription
configKeys[String!]
metadataCommandMetadataInput!
sourceEnvironmentIdString!
targetEnvironmentIdString!
tenantIdString!

ProposeCustomerServiceActionInput

FieldTypeDescription
actionFamilyString
approvalRequestIdID
commandPlanJSON
customerAnswerString
evalScoreFloat
expectedVersionInt!
metadataCommandMetadataInput!
modelIdString
policyDecisionString
progressiveActionIdID
rationaleString
requestIdID!
riskClassString
tenantIdString!

ProposeProgressiveActionInput

FieldTypeDescription
actionKindString!
actionMetadataJSON
commandTypeString
correlationIdString
expiresAtDateTime
metadataCommandMetadataInput!
moduleSlotString!
proposalPayloadJSON
riskClassString!
skillIdString
skipPreviewBoolean
tenantIdString!

PublishChannelListingInput

FieldTypeDescription
expectedVersionInt!
listingIdID!
metadataCommandMetadataInput!
tenantIdString!

ReallocateReservationLotInput

FieldTypeDescription
expectedReservationVersionInt!
lotAllocationPolicyIdString
lotAllocationStrategyString
metadataCommandMetadataInput!
reservationIdID!
tenantIdString!

ReasonedProgressiveActionInput

FieldTypeDescription
actionIdID!
expectedVersionInt!
metadataCommandMetadataInput!
reasonString!
tenantIdString!

RebuildChannelAvailabilityInput

FieldTypeDescription
metadataCommandMetadataInput!
scopeIdID
scopeKindString!
tenantIdString!

RebuildLotsFromLedgerInput

FieldTypeDescription
inventoryLevelIdID!
metadataCommandMetadataInput!
tenantIdString!

ReceiveReturnInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
returnIdID!
tenantIdString!

ReceiveStockTransferInput

FieldTypeDescription
expectedToInventoryLevelVersionInt!
expectedVersionInt!
metadataCommandMetadataInput!
receivedOnDateTime!
receivedQuantityFloat!
stockTransferIdID!
tenantIdString!

RecomputeFutureAvailabilityInput

FieldTypeDescription
locationIdID!
metadataCommandMetadataInput!
reasonCodeString
tenantIdString!
variantIdID!

RecordAhaMomentInput

FieldTypeDescription
evidenceCorrelationIdString!
expectedVersionInt!
metadataCommandMetadataInput!
scenarioIdString!
tenantIdString!

RecordAppUserSessionHeartbeatInput

FieldTypeDescription
appIdString
appInstallationIdString
appSurfaceString!
browserNameString
deviceLabelString
deviceTypeString
ipHashString
metadataCommandMetadataInput!
occurredOnDateTime
osNameString
tenantIdString!
userAgentString
webSessionIdString!

RecordConnectorWebhookReceiptInput

FieldTypeDescription
bindingIdID!
bodyHashString!
connectorKeyString!
deliveryIdString!
externalAccountRefString
hmacVerifiedBoolean!
lastErrorString
metadataCommandMetadataInput!
providerString!
providerEventIdString
providerReferenceString
rawPayloadRefString
receivedOnDateTime
replayFingerprintString!
statusString!
tenantIdString!
topicString!

RecordCountLineInput

FieldTypeDescription
countSessionIdString!
countedByIdString
countedByTypeString
countedOnDateTime!
countedQuantityInt!
inventoryLevelIdString!
locationIdString!
metadataCommandMetadataInput!
quantityTypeString!
tenantIdString!
toleranceClassString
variantIdString!

RecordFulfillmentOrderLinePackInput

FieldTypeDescription
evidenceRefString
expectedVersionInt!
fulfillmentOrderIdID!
fulfillmentOrderLineIdID!
metadataCommandMetadataInput!
packageRefString
quantityInt!
tenantIdString!

RecordFulfillmentOrderLinePickInput

FieldTypeDescription
evidenceRefString
expectedVersionInt!
fulfillmentOrderIdID!
fulfillmentOrderLineIdID!
metadataCommandMetadataInput!
quantityInt!
sourceBinIdID
tenantIdString!

RedactCustomerDataInput

FieldTypeDescription
bindingIdID!
metadataCommandMetadataInput!
partnerCustomerEmailString
partnerCustomerIdString!
receivedOnDateTime!
tenantIdString!

RedactShopDataInput

FieldTypeDescription
bindingIdID!
metadataCommandMetadataInput!
operatorApprovalReceiptIdID!
partnerShopIdString!
receivedOnDateTime!
shopDomainString!
tenantIdString!

RegisterFutureSupplyInput

FieldTypeDescription
confidenceScoreFloat
expectedOnDateTime!
initialStatusString
inventoryLevelIdID!
inventoryLotIdID
metadataCommandMetadataInput!
quantityFloat!
reasonCodeString
sourceIdString!
sourceTypeString!
tenantIdString!

RejectReturnInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
rejectionReasonString!
returnIdID!
tenantIdString!

ReleaseBundleReservationInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
reasonCodeString
reservationGroupIdID!
tenantIdString!

ReleaseReservationInput

FieldTypeDescription
expectedReservationVersionInt!
metadataCommandMetadataInput!
reasonCodeString
reservationIdID!
tenantIdString!

RemoveSubstituteMemberInput

FieldTypeDescription
expectedVersionInt!
memberIdString!
metadataCommandMetadataInput!
reasonCodeString
tenantIdString!

ReplayWebhookDeliveryInput

FieldTypeDescription
metadataCommandMetadataInput!
resetAttemptsBoolean
tenantIdString!
webhookDeliveryIdID!

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).

FieldTypeDescription
bucketRangeAnalyticsExportBucketRangeInput!
metadataCommandMetadataInput!
reportDefJSON!
tenantIdString!

RequestApprovalInput

FieldTypeDescription
dueOnDateTime
entityIdString!
entityTypeString!
metadataCommandMetadataInput!
requestedActionString!
requestedReasonString
tenantIdString!

ReserveBundleInput

FieldTypeDescription
bundleIdID!
cartIdID
componentReservations[ComponentReservationInput!]!
expiresOnDateTime
metadataCommandMetadataInput!
orderIdID
reasonCodeString
reservationGroupIdID
reservationTypeString!
tenantIdString!

ResetOnboardingInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
reasonString!
tenantIdString!

ResolveApprovalInput

FieldTypeDescription
approvalRequestIdID!
metadataCommandMetadataInput!
resolutionString!
resolutionReasonString
tenantIdString!

ResolveCustomerServiceRequestInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
requestIdID!
resolutionSummaryString!
resolvedCommandReceiptIdID
tenantIdString!

ResolveExternalTaskInput

FieldTypeDescription
externalTaskIdID!
metadataCommandMetadataInput!
outputPayloadJSON
resolutionString!
tenantIdString!

ResolveReconciliationDifferenceInput

FieldTypeDescription
decisionReasonString!
decisionTypeString!
metadataCommandMetadataInput!
reconciliationDifferenceIdID!
tenantIdString!

ResolveReturnInput

FieldTypeDescription
currencyString
expectedVersionInt!
metadataCommandMetadataInput!
refundMinorInt
resolutionString!REFUND \
returnIdID!
tenantIdString!

RestoreInventoryFromDamagedInput

FieldTypeDescription
expectedVersionInt!
inventoryLevelIdID!
inventoryLotIdID
metadataCommandMetadataInput!
notesString
quantityFloat!
reasonCodeStringAccepted values: REPAIR_COMPLETED, INSPECTION_CLEARED, OPERATOR_OVERRIDE. Defaults to REPAIR_COMPLETED.
tenantIdString!

ResumeJobScheduleInput

FieldTypeDescription
metadataCommandMetadataInput!
nextRunOnDateTime
reasonString
scheduleIdID!
tenantIdString!

ResumeWebhookSubscriptionInput

FieldTypeDescription
metadataCommandMetadataInput!
tenantIdString!
webhookSubscriptionIdID!

RetireBusinessUnitInput

FieldTypeDescription
businessUnitIdID!
expectedVersionInt!
metadataCommandMetadataInput!
tenantIdString!

RetireChannelAssignmentInput

FieldTypeDescription
assignmentIdID!
expectedVersionInt!
metadataCommandMetadataInput!
tenantIdString!

RetireCommerceMarketInput

FieldTypeDescription
expectedVersionInt!
marketIdID!
metadataCommandMetadataInput!
tenantIdString!

RetireSubstituteGroupInput

FieldTypeDescription
expectedVersionInt!
groupIdString!
metadataCommandMetadataInput!
reasonCodeString
tenantIdString!

RotateShopifyTokenInput

FieldTypeDescription
accessTokenSecretRefString!
bindingIdID!
metadataCommandMetadataInput!
rotatedByActorIdString!
scope[String!]
tenantIdString!

RotateWebhookSubscriptionSecretInput

FieldTypeDescription
metadataCommandMetadataInput!
tenantIdString!
webhookSubscriptionIdID!

SaveAnalyticsReportDefinitionInput

FieldTypeDescription
displayNameString!
environmentIdString!
metadataCommandMetadataInput!
reportKeyString!
requestJSON!
tenantIdString!

SeedSampleInventoryInput

FieldTypeDescription
dryRunBoolean
metadataCommandMetadataInput!
scenarioIdString!
tenantIdString!

SendAdminBroadcastInput

FieldTypeDescription
actionLabelString
actionPayloadJSON
actionRouteRefString
actionUrlString
bodyString!
expiresOnDateTime
feedBadgeLabelString
feedBadgeToneString
feedCategoryString
feedMetadataJSON
metadataCommandMetadataInput!
severityString
sourceAppInstallationIdString
sourceEventIdString
targetAppInstallationIdString
targetRoleString
targetScopeString
targetUserIdString
tenantIdString!
titleString!
triggerEntityIdString
triggerEntityTypeString
triggerEventTypeString

SetOnboardingPersonaInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
personaString!
tenantIdString!

ShipStockTransferInput

FieldTypeDescription
carrierString
expectedFromInventoryLevelVersionInt!
expectedVersionInt!
metadataCommandMetadataInput!
shippedOnDateTime!
stockTransferIdID!
tenantIdString!
trackingRefString

SkipOnboardingStepInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
nextStepIdString!
reasonString!
stepIdString!
tenantIdString!

StartCountSessionInput

FieldTypeDescription
countedOnDateTime
locationIdString!
metadataCommandMetadataInput!
sessionTypeString!
sourceRefString
sourceSystemString
tenantIdString!

StartFulfillmentOrderPickingInput

FieldTypeDescription
expectedVersionInt!
fulfillmentOrderIdID!
metadataCommandMetadataInput!
tenantIdString!

StartOnboardingInput

FieldTypeDescription
metadataCommandMetadataInput!
sourceString
tenantIdString!

SuppressChannelListingInput

FieldTypeDescription
expectedVersionInt!
listingIdID!
metadataCommandMetadataInput!
suppressedReasonString!
tenantIdString!

TenantDeploymentInput

FieldTypeDescription
archiveStorageRefString
auditLogRefString
backupPolicyRefString
cellIdString
databaseRefString!
deploymentIdString
deploymentKeyString!
expectedVersionInt!
indexRefString
isolationModeString!
kmsKeyRefString
lifecycleStageString
logSinkRefString
migrationStateJSON
objectStoragePrefixString
objectStorageRefString
queueLaneRefString
readReplicaRefString
regionString!
routingMetadataJSON
schemaRefString
secretsRefString
statusString
storageModeString!
workerPoolRefString

UninstallShopifyConnectorInput

FieldTypeDescription
bindingIdID!
detailString
metadataCommandMetadataInput!
reasonString!
tenantIdString!

UpdateAnalyticsAlertInput

FieldTypeDescription
channels[String!]
descriptionString
displayNameString!
escalationAfterHoursInt
expectedVersionInt!
metadataCommandMetadataInput!
muteUntilString
ruleKeyString!
scopeAnalyticsAlertScope!
severityString!
specJSON!
statusString
tenantIdString!

UpdateDropshipFeedInput

FieldTypeDescription
connectorKeyString
expectedVersionInt!
feedIdString!
metadataCommandMetadataInput!
scheduleCronString
stalenessThresholdSecondsInt
statusString
tenantIdString!

UpdateFutureSupplyInput

FieldTypeDescription
confidenceScoreFloat
expectedOnDateTime
expectedVersionInt!
futureQuantityIdID!
metadataCommandMetadataInput!
quantityFloat
reasonCodeString
tenantIdString!

UpdateLocationInput

FieldTypeDescription
addressLine1String
addressLine2String
alcoholLicensedBoolean
capacityPalletsInt
capacitySqFtInt
capacityUnitsInt
cityString
closedOnString
coldChainBoolean
contactPartyIdString
countryString
crossDockCapableBoolean
emailString
expectedVersionInt!
handlingCutoffLocalTimeString
hazmatCertifiedBoolean
isReturnDestinationBoolean
isTransferDestinationBoolean
latitudeFloat
locationIdID!
locationRefString
locationTypeString
longitudeFloat
lotTrackingEnabledBoolean
metadataCommandMetadataInput!
nameString
openedOnString
parentLocationIdString
phoneString
pickupEnabledBoolean
postalCodeString
regionCodeString
serialTrackingEnabledBoolean
serviceEnabledBoolean
shipFromStoreEnabledBoolean
stateString
taxJurisdictionRefString
temperatureControlledBoolean
tenantIdString!
timeZoneString
trustLevelString

UpdateProductInput

FieldTypeDescription
expectedVersionInt!
metadataCommandMetadataInput!
nameString
productIdID!
productRefString
tenantIdString!

UpdateProductVariantInput

FieldTypeDescription
barcodeString
defaultShelfLifeDaysInt
expectedVersionInt!
exportControlClassString
hazmatClassString
hsCodeString
metadataCommandMetadataInput!
optionValuesJSON
requiresExpiryTrackingBoolean
requiresLotTrackingBoolean
requiresSerialTrackingBoolean
skuString
temperatureZoneString
tenantIdString!
trackingTypeString
uomString
variantIdID!

UpsertBusinessUnitInput

FieldTypeDescription
descriptionString
displayNameString!
expectedVersionInt!
metadataCommandMetadataInput!
parentBuIdID
statusString
tenantIdString!
unitKeyString!

UpsertChannelAssignmentInput

FieldTypeDescription
assignmentKeyString!
businessUnitIdID
channelExposureStrategyIdID
commerceMarketIdID
eligibilityProfileIdID
expectedVersionInt!
fulfillmentNetworkIdID
metadataCommandMetadataInput!
priorityInt
salesChannelIdID
scopeKindString!
sourcingProfileIdID
statusString
tenantIdString!
validFromString
validToString

UpsertChannelListingInput

FieldTypeDescription
channelIdString!
descriptionString
expectedVersionInt!
externalListingIdString
metadataCommandMetadataInput!
productIdString!
tenantIdString!
titleString
variantIdString!

UpsertChannelOfferInput

FieldTypeDescription
compareAtPriceMinorInt
currencyString!
effectiveFromString!
effectiveToString
expectedVersionInt!
listingIdID!
metadataCommandMetadataInput!
offerIdID
priceListIdID
priceMinorInt!
tenantIdString!

UpsertCommerceMarketInput

FieldTypeDescription
countryCodes[String!]
defaultCurrencyString!
descriptionString
displayNameString!
expectedVersionInt!
localeCodes[String!]
marketKeyString!
marketTypeString!
marketplaceRefString
metadataCommandMetadataInput!
regionCodeString
statusString
taxJurisdictionRefString
tenantIdString!

UpsertCustomFieldInput

FieldTypeDescription
booleanValueBoolean
dateValueString
entityIdString!
entityTypeString!
expectedVersionInt
fieldGroupString
isIndexedBoolean
jsonValueJSON
keyString!
metadataCommandMetadataInput!
namespaceString!
numberValueFloat
sourceSystemString
stringValueString
tenantIdString!
valueTypeString!

UpsertJobScheduleInput

FieldTypeDescription
jobTypeString!
maxAttemptsInt
metadataCommandMetadataInput!
nextRunOnDateTime!
payloadTemplateJSON
scheduleConfigJSON!
scheduleIdID
scheduleKeyString!
scheduleTypeString!
statusString
statusReasonString
tenantIdString!

UpsertLocationOperatingExceptionInput

FieldTypeDescription
closesAtString
exceptionDateString!
isClosedBoolean
locationIdID!
metadataCommandMetadataInput!
opensAtString
reasonString
tenantIdString!

UpsertLocationOperatingHoursInput

FieldTypeDescription
expectedVersionInt!
hours[LocationOperatingHoursEntryInput!]!
locationIdID!
metadataCommandMetadataInput!
tenantIdString!

UpsertSubstituteGroupInput

FieldTypeDescription
channelIdString
descriptionString
expectedVersionInt!
groupKeyString!
metadataCommandMetadataInput!
primaryVariantIdString!
priorityInt
statusString
tenantIdString!
validFromString
validToString

UpsertSubstituteMemberInput

FieldTypeDescription
expectedVersionInt!
groupIdString!
metadataCommandMetadataInput!
priorityInt
statusString
substituteFactorFloat!
substituteVariantIdString!
tenantIdString!

UpsertTenantConfigInput

FieldTypeDescription
configKeyString!
descriptionString
expectedVersionInt!
metadataCommandMetadataInput!
tenantIdString!
valueJSON!

UpsertTenantEnvironmentInput

FieldTypeDescription
dataClassificationString
deletionPolicyRefString
deploymentTenantDeploymentInput
environmentIdString!
environmentKeyString
environmentMetadataJSON
environmentTypeString!
expectedEnvironmentVersionInt!
lifecycleStageString
metadataCommandMetadataInput!
nameString
promotionPolicyRefString
retentionPolicyRefString
sourceEnvironmentIdString
statusString
tenantIdString!

UpsertWebhookSubscriptionInput

FieldTypeDescription
deliveryModeString!
eventPatternString!
metadataCommandMetadataInput!
signingSecretRefString!
statusString
targetUrlString!
tenantIdString!
webhookSubscriptionIdID
Privacy choices

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

Read the privacy notice