Mutation
The schema's entry-point for mutations. This acts as the public, top-level API from which all mutations must start.
Anchor to FieldsFields
- appCreditCreate (AppCreditCreatePayload)
- appSubscriptionCancel (AppSubscriptionCancelPayload)
- appSubscriptionMigrationOperationCancel (AppSubscriptionMigrationOperationCancelPayload)
- appSubscriptionMigrationOperationCreate (AppSubscriptionMigrationOperationCreatePayload)
- eventsinkCreate (EventsinkCreatePayload)
- eventsinkDelete (EventsinkDeletePayload)
- Anchor to appCreditCreateapp•App
Credit Create Credit Create Payload Allows an app to create a credit for a shop that can be used towards future app purchases. This mutation is only available to Partner API clients that have been granted the
View financialspermission.- Anchor to amountamount•Money
Input! required The amount that can be used towards future app purchases in Shopify.
- Anchor to appIdapp•ID!
Id required The id of the app to associate the credit with. Example value:
.- Anchor to descriptiondescription•String!required
The description of the app credit.
- Anchor to shopIdshop•ID!
Id required The id of the shop to be credited. Example value:
.- Anchor to testtest•BooleanDefault:false
Specifies whether the app credit is a test transaction.
Arguments
- Anchor to appSubscriptionCancelapp•App
Subscription Cancel Subscription Cancel Payload Cancels an app subscription.
- Anchor to appIdapp•ID!
Id required The id of the app. Example value:
.- Anchor to deferCancellationdefer•Boolean!
Cancellation required Whether to defer cancellation until the end of the current billing cycle.
- Anchor to prorateprorate•Boolean!required
Whether to issue prorated credits for the unused portion of the subscription. Cannot be used together with
.- Anchor to shopIdshop•ID!
Id required The id of the shop. Example value:
.- Anchor to skipFinalUsageChargeskip•Boolean!
Final Usage Charge required Whether to skip the final usage charge when cancelling. Only applicable to usage-billed subscriptions. Cannot be used together with
prorate.
Arguments
- Anchor to appSubscriptionMigrationOperationCancelapp•App
Subscription Migration Operation Cancel Subscription Migration Operation Cancel Payload Cancels an app subscription migration operation.
- Anchor to appIdapp•ID!
Id required The ID of the app. Example value:
.- •ID!required
The ID of the operation. Example value:
.
Arguments
- Anchor to appSubscriptionMigrationOperationCreateapp•App
Subscription Migration Operation Create Subscription Migration Operation Create Payload Creates an app subscription migration operation for a batch of shops.
- Anchor to appIdapp•ID!
Id required The ID of the app. Example value:
.- Anchor to idempotencyKeyidempotency•String
Key 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•[App
Subscription Migration Input!]! required The migration actions to perform, one per shop.
Arguments
- Anchor to eventsinkCreateeventsink•Eventsink
Create Create Payload Creates a new Eventsink.
- Anchor to inputinput•Eventsink
Create Input! required Details of eventsink to create.
Arguments
- Anchor to eventsinkDeleteeventsink•Eventsink
Delete Delete Payload Deletes an Eventsink.
- Anchor to appIdapp•ID!
Id required The App that associated with the Eventsink.
- •ID!required
Eventsink to delete.
- Anchor to topictopic•Eventsink
Topic! required The topic of the Eventsink.
Arguments