storeCreditAccountCredit

mutation

Requires write_store_credit_account_transactions access scope.

Creates a credit transaction that increases the store credit account balance by the given amount. This operation will create an account if one does not already exist. A store credit account owner can hold multiple accounts each with a different currency. Use the most appropriate currency for the given store credit account owner.

Arguments

Anchor to creditInputcreditInput • StoreCreditAccountCreditInput!required: The input fields for a store credit account credit transaction.
Anchor to idid • ID!required: The ID of the store credit account or the ID of the account owner.

Was this section helpful?

Anchor to StoreCreditAccountCreditPayload returnsStoreCreditAccountCreditPayload returns

Anchor to storeCreditAccountTransactionstoreCreditAccountTransaction • StoreCreditAccountCreditTransaction: The store credit account transaction that was created.
Anchor to userErrorsuserErrors • [StoreCreditAccountCreditUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Credit an amount to a store credit account by customer ID
Credit an expiring amount to a store credit account by account ID
Crediting a negative amount returns an error
Crediting an amount that exceeds the account limit returns an error
storeCreditAccountCredit reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {
6    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {
7      storeCreditAccountTransaction {
8        amount {
9          amount
10          currencyCode
11        }
12        account {
13          id
14          balance {
15            amount
16            currencyCode
17          }
18        }
19      }
20      userErrors {
21        message
22        field
23      }
24    }
25  }`,
26  {
27    variables: {
28      "id": "gid://shopify/Customer/544365967",
29      "creditInput": {
30        "creditAmount": {
31          "amount": "49.99",
32          "currencyCode": "USD"
33        }
34      }
35    },
36  },
37);
38
39const data = await response.json();
40

mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {
  storeCreditAccountCredit(id: $id, creditInput: $creditInput) {
    storeCreditAccountTransaction {
      amount {
        amount
        currencyCode
      }
      account {
        id
        balance {
          amount
          currencyCode
        }
      }
    }
    userErrors {
      message
      field
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) { storeCreditAccountCredit(id: $id, creditInput: $creditInput) { storeCreditAccountTransaction { amount { amount currencyCode } account { id balance { amount currencyCode } } } userErrors { message field } } }",
 "variables": {
    "id": "gid://shopify/Customer/544365967",
    "creditInput": {
      "creditAmount": {
        "amount": "49.99",
        "currencyCode": "USD"
      }
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {
    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {
      storeCreditAccountTransaction {
        amount {
          amount
          currencyCode
        }
        account {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Customer/544365967",
      "creditInput": {
        "creditAmount": {
          "amount": "49.99",
          "currencyCode": "USD"
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {
      storeCreditAccountCredit(id: $id, creditInput: $creditInput) {
        storeCreditAccountTransaction {
          amount {
            amount
            currencyCode
          }
          account {
            id
            balance {
              amount
              currencyCode
            }
          }
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Customer/544365967",
      "creditInput": {
        "creditAmount": {
          "amount": "49.99",
          "currencyCode": "USD"
        }
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {
    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {
      storeCreditAccountTransaction {
        amount {
          amount
          currencyCode
        }
        account {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Customer/544365967",
  "creditInput": {
    "creditAmount": {
      "amount": "49.99",
      "currencyCode": "USD"
    }
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "id": "gid://shopify/Customer/544365967",
3  "creditInput": {
4    "creditAmount": {
5      "amount": "49.99",
6      "currencyCode": "USD"
7    }
8  }
9}

Response

JSON

1{
2  "storeCreditAccountCredit": {
3    "storeCreditAccountTransaction": {
4      "amount": {
5        "amount": "49.99",
6        "currencyCode": "USD"
7      },
8      "account": {
9        "id": "gid://shopify/StoreCreditAccount/316863792",
10        "balance": {
11          "amount": "61.1",
12          "currencyCode": "USD"
13        }
14      }
15    },
16    "userErrors": []
17  }
18}