appSubscriptionMigrationOperationCreate

mutation

Creates an app subscription migration operation for a batch of shops.

Anchor to Arguments

Arguments

Anchor to appIdappId

•ID!

required

The ID of the app. Example value: gid://shopify/App/123.

Anchor to idempotencyKeyidempotencyKey

•String

A key that identifies this batch. Submitting the same key again returns the operation created the first time instead of creating another one, including after that operation has been canceled. Defaults to a digest of the batch, so retrying an identical request is safe without supplying one. Pass a new key to reschedule a batch that was previously canceled.

Anchor to inputinput

•[AppSubscriptionMigrationInput!]!

required

The migration actions to perform, one per shop.

Was this section helpful?

Anchor to AppSubscriptionMigrationOperationCreatePayload returnsAppSubscriptionMigrationOperationCreatePayload returns

Anchor to operationoperation •AppSubscriptionMigrationOperation: The migration operation that was created.
Anchor to userErrorsuserErrors •[UserError!]: Errors when creating the migration operation.

Was this section helpful?

Examples

appSubscriptionMigrationOperationCreate reference

Mutation Reference

mutation appSubscriptionMigrationOperationCreate($appId: ID!, $idempotencyKey: String, $input: [AppSubscriptionMigrationInput!]!) {

appSubscriptionMigrationOperationCreate(appId: $appId, idempotencyKey: $idempotencyKey, input: $input) {

operation {

# AppSubscriptionMigrationOperation fields

}

userErrors {

field

message

}

Input

{

"appId": "gid://shopify/<objectName>/10079785100",

"idempotencyKey": "<your-idempotencyKey>",

"input": [

{

"action": {

"cancelMigration": true,

"scheduleMigration": {}

"shopId": "gid://shopify/<objectName>/10079785100"

}

]

}

Variables

{
  "appId": "gid://shopify/<objectName>/10079785100",
  "idempotencyKey": "<your-idempotencyKey>",
  "input": [
    {
      "action": {
        "cancelMigration": true,
        "scheduleMigration": {}
      },
      "shopId": "gid://shopify/<objectName>/10079785100"
    }
  ]
}

Schema

input AppSubscriptionMigrationInput {
  action: AppSubscriptionMigrationActionInput!
  shopId: ID!
}

input AppSubscriptionMigrationActionInput {
  cancelMigration: Boolean
  scheduleMigration: AppSubscriptionMigrationScheduleInput
}