appCreditCreate - partner - MUTATION

Version: unstable

Description:

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.

Access Scopes

Arguments

• amount: MoneyInput! - The amount that can be used towards future app purchases in Shopify.
• appId: ID! - The id of the app to associate the credit with. Example value: `gid://partners/App/123`.
• description: String! - The description of the app credit.
• shopId: ID! - The id of the shop to be credited. Example value: `gid://partners/Shop/456`.
• test: Boolean - Specifies whether the app credit is a test transaction.

Returns

• appCredit: AppCredit The app credit that was created.
• userErrors: UserError Errors when creating the application credit.

Examples

• Creates an app credit

          Curl example: "curl -X POST \\\nhttps://partners.shopify.com/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {partner_access_token}' \\\n-d '{\n\"query\": \"mutation appCreditCreate($appId: ID!, $shopId: ID!, $amount: MoneyInput!, $description: String!, $test: Boolean) { appCreditCreate(appId: $appId, shopId: $shopId, amount: $amount, description: $description, test: $test) { appCredit { id, test, name, amount { amount, currencyCode, } } userErrors{ field, message } } }\"\n}'\n"
          Node example: null
          Ruby example: null
          PHP example: null
          Remix example: null
          Graphql query: "mutation appCreditCreate($appId: ID!, $shopId: ID!, $amount: MoneyInput!, $description: String!, $test: Boolean) {\n      appCreditCreate(appId: $appId, shopId: $shopId, amount: $amount, description: $description, test: $test) {\n        appCredit {\n          id,\n          test,\n          name,\n          amount {\n            amount,\n            currencyCode,\n          }\n        }\n        userErrors{\n          field,\n          message\n        }\n      }\n    }"
        

  input: null

  response: {
    "data": {
      "appCreditCreate": {
        "appCredit": {
          "id": "gid://shopify/AppCredit/1",
          "test": false,
          "name": "app credit description",
          "amount": {
            "amount": "100.0",
            "currencyCode": "USD"
          }
        },
        "userErrors": []
      }
    }
  }