storeCreditAccountCredit - admin-graphql - MUTATION

Version: 2024-10

Description:

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.

Access Scopes

`write_store_credit_account_transactions` access scope.

Arguments

• creditInput: StoreCreditAccountCreditInput! - The input fields for a store credit account credit transaction.
• id: ID! - The ID of the store credit account or the ID of the account owner.

Returns

• storeCreditAccountTransaction: StoreCreditAccountCreditTransaction The store credit account transaction that was created.
• userErrors: StoreCreditAccountCreditUserError! The list of errors that occurred from executing the mutation.

Examples

• Credit an amount to a store credit account by customer ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) { storeCreditAccountCredit(id: $id, creditInput: $creditInput) { storeCreditAccountTransaction { amount { amount currencyCode } account { id balance { amount currencyCode } } } userErrors { message field } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Customer/544365967\",\n    \"creditInput\": {\n      \"creditAmount\": {\n        \"amount\": \"49.99\",\n        \"currencyCode\": \"USD\"\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n      storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n        storeCreditAccountTransaction {\n          amount {\n            amount\n            currencyCode\n          }\n          account {\n            id\n            balance {\n              amount\n              currencyCode\n            }\n          }\n        }\n        userErrors {\n          message\n          field\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Customer/544365967\",\n      \"creditInput\": {\n        \"creditAmount\": {\n          \"amount\": \"49.99\",\n          \"currencyCode\": \"USD\"\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n      storeCreditAccountTransaction {\n        amount {\n          amount\n          currencyCode\n        }\n        account {\n          id\n          balance {\n            amount\n            currencyCode\n          }\n        }\n      }\n      userErrors {\n        message\n        field\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Customer/544365967\",\n  \"creditInput\": {\n    \"creditAmount\": {\n      \"amount\": \"49.99\",\n      \"currencyCode\": \"USD\"\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Customer/544365967\",\n  \"creditInput\" => [\n    \"creditAmount\" => [\n      \"amount\" => \"49.99\",\n      \"currencyCode\" => \"USD\",\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n      storeCreditAccountTransaction {\n        amount {\n          amount\n          currencyCode\n        }\n        account {\n          id\n          balance {\n            amount\n            currencyCode\n          }\n        }\n      }\n      userErrors {\n        message\n        field\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Customer/544365967\",\n      \"creditInput\": {\n        \"creditAmount\": {\n          \"amount\": \"49.99\",\n          \"currencyCode\": \"USD\"\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n  storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n    storeCreditAccountTransaction {\n      amount {\n        amount\n        currencyCode\n      }\n      account {\n        id\n        balance {\n          amount\n          currencyCode\n        }\n      }\n    }\n    userErrors {\n      message\n      field\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "storeCreditAccountCredit": {
        "storeCreditAccountTransaction": {
          "amount": {
            "amount": "49.99",
            "currencyCode": "USD"
          },
          "account": {
            "id": "gid://shopify/StoreCreditAccount/316863792",
            "balance": {
              "amount": "61.1",
              "currencyCode": "USD"
            }
          }
        },
        "userErrors": []
      }
    }
  }

  Credit an expiring amount to a store credit account by account ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) { storeCreditAccountCredit(id: $id, creditInput: $creditInput) { storeCreditAccountTransaction { amount { amount currencyCode } account { id balance { amount currencyCode } } } userErrors { message field } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/StoreCreditAccount/316863792\",\n    \"creditInput\": {\n      \"expiresAt\": \"2028-10-26\",\n      \"creditAmount\": {\n        \"amount\": \"49.99\",\n        \"currencyCode\": \"USD\"\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n      storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n        storeCreditAccountTransaction {\n          amount {\n            amount\n            currencyCode\n          }\n          account {\n            id\n            balance {\n              amount\n              currencyCode\n            }\n          }\n        }\n        userErrors {\n          message\n          field\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/StoreCreditAccount/316863792\",\n      \"creditInput\": {\n        \"expiresAt\": \"2028-10-26\",\n        \"creditAmount\": {\n          \"amount\": \"49.99\",\n          \"currencyCode\": \"USD\"\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n      storeCreditAccountTransaction {\n        amount {\n          amount\n          currencyCode\n        }\n        account {\n          id\n          balance {\n            amount\n            currencyCode\n          }\n        }\n      }\n      userErrors {\n        message\n        field\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/StoreCreditAccount/316863792\",\n  \"creditInput\": {\n    \"expiresAt\": \"2028-10-26\",\n    \"creditAmount\": {\n      \"amount\": \"49.99\",\n      \"currencyCode\": \"USD\"\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/StoreCreditAccount/316863792\",\n  \"creditInput\" => [\n    \"expiresAt\" => \"2028-10-26\",\n    \"creditAmount\" => [\n      \"amount\" => \"49.99\",\n      \"currencyCode\" => \"USD\",\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n      storeCreditAccountTransaction {\n        amount {\n          amount\n          currencyCode\n        }\n        account {\n          id\n          balance {\n            amount\n            currencyCode\n          }\n        }\n      }\n      userErrors {\n        message\n        field\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/StoreCreditAccount/316863792\",\n      \"creditInput\": {\n        \"expiresAt\": \"2028-10-26\",\n        \"creditAmount\": {\n          \"amount\": \"49.99\",\n          \"currencyCode\": \"USD\"\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n  storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n    storeCreditAccountTransaction {\n      amount {\n        amount\n        currencyCode\n      }\n      account {\n        id\n        balance {\n          amount\n          currencyCode\n        }\n      }\n    }\n    userErrors {\n      message\n      field\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/StoreCreditAccount/316863792",
    "creditInput": {
      "expiresAt": "2028-10-26",
      "creditAmount": {
        "amount": "49.99",
        "currencyCode": "USD"
      }
    }
  }

  response: {
    "data": {
      "storeCreditAccountCredit": {
        "storeCreditAccountTransaction": {
          "amount": {
            "amount": "49.99",
            "currencyCode": "USD"
          },
          "account": {
            "id": "gid://shopify/StoreCreditAccount/316863792",
            "balance": {
              "amount": "61.1",
              "currencyCode": "USD"
            }
          }
        },
        "userErrors": []
      }
    }
  }

  Crediting a negative amount returns an error

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) { storeCreditAccountCredit(id: $id, creditInput: $creditInput) { storeCreditAccountTransaction { amount { amount currencyCode } account { id balance { amount currencyCode } } } userErrors { message field } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Customer/1018520244\",\n    \"creditInput\": {\n      \"creditAmount\": {\n        \"amount\": \"-100.00\",\n        \"currencyCode\": \"USD\"\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n      storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n        storeCreditAccountTransaction {\n          amount {\n            amount\n            currencyCode\n          }\n          account {\n            id\n            balance {\n              amount\n              currencyCode\n            }\n          }\n        }\n        userErrors {\n          message\n          field\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Customer/1018520244\",\n      \"creditInput\": {\n        \"creditAmount\": {\n          \"amount\": \"-100.00\",\n          \"currencyCode\": \"USD\"\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n      storeCreditAccountTransaction {\n        amount {\n          amount\n          currencyCode\n        }\n        account {\n          id\n          balance {\n            amount\n            currencyCode\n          }\n        }\n      }\n      userErrors {\n        message\n        field\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Customer/1018520244\",\n  \"creditInput\": {\n    \"creditAmount\": {\n      \"amount\": \"-100.00\",\n      \"currencyCode\": \"USD\"\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Customer/1018520244\",\n  \"creditInput\" => [\n    \"creditAmount\" => [\n      \"amount\" => \"-100.00\",\n      \"currencyCode\" => \"USD\",\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n      storeCreditAccountTransaction {\n        amount {\n          amount\n          currencyCode\n        }\n        account {\n          id\n          balance {\n            amount\n            currencyCode\n          }\n        }\n      }\n      userErrors {\n        message\n        field\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Customer/1018520244\",\n      \"creditInput\": {\n        \"creditAmount\": {\n          \"amount\": \"-100.00\",\n          \"currencyCode\": \"USD\"\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n  storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n    storeCreditAccountTransaction {\n      amount {\n        amount\n        currencyCode\n      }\n      account {\n        id\n        balance {\n          amount\n          currencyCode\n        }\n      }\n    }\n    userErrors {\n      message\n      field\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/Customer/1018520244",
    "creditInput": {
      "creditAmount": {
        "amount": "-100.00",
        "currencyCode": "USD"
      }
    }
  }

  response: {
    "data": {
      "storeCreditAccountCredit": {
        "storeCreditAccountTransaction": null,
        "userErrors": [
          {
            "message": "A positive amount must be used to credit a store credit account",
            "field": [
              "creditInput",
              "creditAmount",
              "amount"
            ]
          }
        ]
      }
    }
  }

  Crediting an amount that exceeds the account limit returns an error

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) { storeCreditAccountCredit(id: $id, creditInput: $creditInput) { storeCreditAccountTransaction { amount { amount currencyCode } account { id balance { amount currencyCode } } } userErrors { message field } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Customer/1018520244\",\n    \"creditInput\": {\n      \"creditAmount\": {\n        \"amount\": \"100000.00\",\n        \"currencyCode\": \"USD\"\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n      storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n        storeCreditAccountTransaction {\n          amount {\n            amount\n            currencyCode\n          }\n          account {\n            id\n            balance {\n              amount\n              currencyCode\n            }\n          }\n        }\n        userErrors {\n          message\n          field\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Customer/1018520244\",\n      \"creditInput\": {\n        \"creditAmount\": {\n          \"amount\": \"100000.00\",\n          \"currencyCode\": \"USD\"\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n      storeCreditAccountTransaction {\n        amount {\n          amount\n          currencyCode\n        }\n        account {\n          id\n          balance {\n            amount\n            currencyCode\n          }\n        }\n      }\n      userErrors {\n        message\n        field\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Customer/1018520244\",\n  \"creditInput\": {\n    \"creditAmount\": {\n      \"amount\": \"100000.00\",\n      \"currencyCode\": \"USD\"\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Customer/1018520244\",\n  \"creditInput\" => [\n    \"creditAmount\" => [\n      \"amount\" => \"100000.00\",\n      \"currencyCode\" => \"USD\",\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n    storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n      storeCreditAccountTransaction {\n        amount {\n          amount\n          currencyCode\n        }\n        account {\n          id\n          balance {\n            amount\n            currencyCode\n          }\n        }\n      }\n      userErrors {\n        message\n        field\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Customer/1018520244\",\n      \"creditInput\": {\n        \"creditAmount\": {\n          \"amount\": \"100000.00\",\n          \"currencyCode\": \"USD\"\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation storeCreditAccountCredit($id: ID!, $creditInput: StoreCreditAccountCreditInput!) {\n  storeCreditAccountCredit(id: $id, creditInput: $creditInput) {\n    storeCreditAccountTransaction {\n      amount {\n        amount\n        currencyCode\n      }\n      account {\n        id\n        balance {\n          amount\n          currencyCode\n        }\n      }\n    }\n    userErrors {\n      message\n      field\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/Customer/1018520244",
    "creditInput": {
      "creditAmount": {
        "amount": "100000.00",
        "currencyCode": "USD"
      }
    }
  }

  response: {
    "data": {
      "storeCreditAccountCredit": {
        "storeCreditAccountTransaction": null,
        "userErrors": [
          {
            "message": "The operation would cause the account's credit limit to be exceeded",
            "field": [
              "creditInput",
              "creditAmount",
              "amount"
            ]
          }
        ]
      }
    }
  }