Skip to main content
Anchor to UserError

UserError

object

Represents an error in a mutation.

Anchor to FieldsFields

Anchor to fieldfield
•[String!]

The path to the input field that caused the error.

Anchor to messagemessage
•String!
non-null

The error message.

Was this section helpful?

Anchor to MutationsMutations

Anchor to appCreditCreateappCreditCreate
•mutation

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 financials permission.

Arguments

Anchor to amountamount
•MoneyInput!
required

The amount that can be used towards future app purchases in Shopify.

Anchor to appIdappId
•ID!
required

The id of the app to associate the credit with. Example value: gid://partners/App/123.

Anchor to descriptiondescription
•String!
required

The description of the app credit.

Anchor to shopIdshopId
•ID!
required

The id of the shop to be credited. Example value: gid://partners/Shop/456.

Anchor to testtest
•Boolean
Default:false

Specifies whether the app credit is a test transaction.

Fields

Anchor to appCreditappCredit
•AppCredit

The app credit that was created.

Anchor to userErrorsuserErrors
•[UserError!]

Errors when creating the application credit.

Was this section helpful?