Choose a version:

giftCardDebit

mutation

Requires write_gift_card_transactions access scope.

Removes funds from a gift card, decreasing its available balance. Use this for manual balance adjustments — for example, correcting an accidental over-credit or applying a fee.

Anchor to Arguments

Arguments

Anchor to debitInputdebitInput

•GiftCardDebitInput!

required

The input fields to debit a gift card.

Anchor to idid

•ID!

required

The ID of the gift card to be debited.

Was this section helpful?

Anchor to GiftCardDebitPayload returnsGiftCardDebitPayload returns

Anchor to giftCardDebitTransactiongiftCardDebitTransaction •GiftCardDebitTransaction: The gift card debit transaction that was created.
Anchor to userErrorsuserErrors •[GiftCardTransactionUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Debit a gift card by ID

Query

mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
  giftCardDebit(id: $id, debitInput: $debitInput) {
    giftCardDebitTransaction {
      id
      amount {
        amount
        currencyCode
      }
      processedAt
      note
      giftCard {
        id
        balance {
          amount
          currencyCode
        }
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}

Variables

{
  "id": "gid://shopify/GiftCard/411106674",
  "debitInput": {
    "debitAmount": {
      "amount": "10",
      "currencyCode": "USD"
    },
    "processedAt": "2024-09-09T12:48:33-04:00",
    "note": "A note."
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) { giftCardDebit(id: $id, debitInput: $debitInput) { giftCardDebitTransaction { id amount { amount currencyCode } processedAt note giftCard { id balance { amount currencyCode } } } userErrors { message field code } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/411106674",
    "debitInput": {
      "debitAmount": {
        "amount": "10",
        "currencyCode": "USD"
      },
      "processedAt": "2024-09-09T12:48:33-04:00",
      "note": "A note."
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
    giftCardDebit(id: $id, debitInput: $debitInput) {
      giftCardDebitTransaction {
        id
        amount {
          amount
          currencyCode
        }
        processedAt
        note
        giftCard {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/411106674",
        "debitInput": {
            "debitAmount": {
                "amount": "10",
                "currencyCode": "USD"
            },
            "processedAt": "2024-09-09T12:48:33-04:00",
            "note": "A note."
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
    giftCardDebit(id: $id, debitInput: $debitInput) {
      giftCardDebitTransaction {
        id
        amount {
          amount
          currencyCode
        }
        processedAt
        note
        giftCard {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/411106674",
  "debitInput": {
    "debitAmount": {
      "amount": "10",
      "currencyCode": "USD"
    },
    "processedAt": "2024-09-09T12:48:33-04:00",
    "note": "A note."
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
      giftCardDebit(id: $id, debitInput: $debitInput) {
        giftCardDebitTransaction {
          id
          amount {
            amount
            currencyCode
          }
          processedAt
          note
          giftCard {
            id
            balance {
              amount
              currencyCode
            }
          }
        }
        userErrors {
          message
          field
          code
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/411106674",
        "debitInput": {
            "debitAmount": {
                "amount": "10",
                "currencyCode": "USD"
            },
            "processedAt": "2024-09-09T12:48:33-04:00",
            "note": "A note."
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
  giftCardDebit(id: $id, debitInput: $debitInput) {
    giftCardDebitTransaction {
      id
      amount {
        amount
        currencyCode
      }
      processedAt
      note
      giftCard {
        id
        balance {
          amount
          currencyCode
        }
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/GiftCard/411106674",
  "debitInput": {
    "debitAmount": {
      "amount": "10",
      "currencyCode": "USD"
    },
    "processedAt": "2024-09-09T12:48:33-04:00",
    "note": "A note."
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
        giftCardDebit(id: $id, debitInput: $debitInput) {
          giftCardDebitTransaction {
            id
            amount {
              amount
              currencyCode
            }
            processedAt
            note
            giftCard {
              id
              balance {
                amount
                currencyCode
              }
            }
          }
          userErrors {
            message
            field
            code
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/GiftCard/411106674",
        "debitInput": {
            "debitAmount": {
                "amount": "10",
                "currencyCode": "USD"
            },
            "processedAt": "2024-09-09T12:48:33-04:00",
            "note": "A note."
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "giftCardDebit": {
    "giftCardDebitTransaction": {
      "id": "gid://shopify/GiftCardDebitTransaction/1064273912",
      "amount": {
        "amount": "-10.0",
        "currencyCode": "USD"
      },
      "processedAt": "2024-09-09T16:48:33Z",
      "note": "A note.",
      "giftCard": {
        "id": "gid://shopify/GiftCard/411106674",
        "balance": {
          "amount": "15.0",
          "currencyCode": "USD"
        }
      }
    },
    "userErrors": []
  }
}

giftCardDebit reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {

giftCardDebit(id: $id, debitInput: $debitInput) {

giftCardDebitTransaction {

amount {

amount

currencyCode

}

processedAt

note

giftCard {

balance {

amount

currencyCode

}

userErrors {

message

field

code

}

}`,

{

variables: {

"id": "gid://shopify/GiftCard/411106674",

"debitInput": {

"debitAmount": {

"amount": "10",

"currencyCode": "USD"

"processedAt": "2024-09-09T12:48:33-04:00",

"note": "A note."

}

);

const json = await response.json();

return json.data;

}

GQL

mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
  giftCardDebit(id: $id, debitInput: $debitInput) {
    giftCardDebitTransaction {
      id
      amount {
        amount
        currencyCode
      }
      processedAt
      note
      giftCard {
        id
        balance {
          amount
          currencyCode
        }
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) { giftCardDebit(id: $id, debitInput: $debitInput) { giftCardDebitTransaction { id amount { amount currencyCode } processedAt note giftCard { id balance { amount currencyCode } } } userErrors { message field code } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/411106674",
    "debitInput": {
      "debitAmount": {
        "amount": "10",
        "currencyCode": "USD"
      },
      "processedAt": "2024-09-09T12:48:33-04:00",
      "note": "A note."
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
    giftCardDebit(id: $id, debitInput: $debitInput) {
      giftCardDebitTransaction {
        id
        amount {
          amount
          currencyCode
        }
        processedAt
        note
        giftCard {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/411106674",
        "debitInput": {
            "debitAmount": {
                "amount": "10",
                "currencyCode": "USD"
            },
            "processedAt": "2024-09-09T12:48:33-04:00",
            "note": "A note."
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
      giftCardDebit(id: $id, debitInput: $debitInput) {
        giftCardDebitTransaction {
          id
          amount {
            amount
            currencyCode
          }
          processedAt
          note
          giftCard {
            id
            balance {
              amount
              currencyCode
            }
          }
        }
        userErrors {
          message
          field
          code
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/411106674",
        "debitInput": {
            "debitAmount": {
                "amount": "10",
                "currencyCode": "USD"
            },
            "processedAt": "2024-09-09T12:48:33-04:00",
            "note": "A note."
        }
    },
  },
});

Ruby

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 giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
    giftCardDebit(id: $id, debitInput: $debitInput) {
      giftCardDebitTransaction {
        id
        amount {
          amount
          currencyCode
        }
        processedAt
        note
        giftCard {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/411106674",
  "debitInput": {
    "debitAmount": {
      "amount": "10",
      "currencyCode": "USD"
    },
    "processedAt": "2024-09-09T12:48:33-04:00",
    "note": "A note."
  }
}

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

Shopify CLI

shopify app execute \
--query \
'mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
  giftCardDebit(id: $id, debitInput: $debitInput) {
    giftCardDebitTransaction {
      id
      amount {
        amount
        currencyCode
      }
      processedAt
      note
      giftCard {
        id
        balance {
          amount
          currencyCode
        }
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/GiftCard/411106674",
  "debitInput": {
    "debitAmount": {
      "amount": "10",
      "currencyCode": "USD"
    },
    "processedAt": "2024-09-09T12:48:33-04:00",
    "note": "A note."
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation giftCardDebit($id: ID!, $debitInput: GiftCardDebitInput!) {
        giftCardDebit(id: $id, debitInput: $debitInput) {
          giftCardDebitTransaction {
            id
            amount {
              amount
              currencyCode
            }
            processedAt
            note
            giftCard {
              id
              balance {
                amount
                currencyCode
              }
            }
          }
          userErrors {
            message
            field
            code
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/GiftCard/411106674",
        "debitInput": {
            "debitAmount": {
                "amount": "10",
                "currencyCode": "USD"
            },
            "processedAt": "2024-09-09T12:48:33-04:00",
            "note": "A note."
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"id": "gid://shopify/GiftCard/411106674",

"debitInput": {

"debitAmount": {

"amount": "10",

"currencyCode": "USD"

"processedAt": "2024-09-09T12:48:33-04:00",

"note": "A note."

}

Response

JSON

{

"giftCardDebit": {

"giftCardDebitTransaction": {

"id": "gid://shopify/GiftCardDebitTransaction/1064273912",

"amount": {

"amount": "-10.0",

"currencyCode": "USD"

"processedAt": "2024-09-09T16:48:33Z",

"note": "A note.",

"giftCard": {

"id": "gid://shopify/GiftCard/411106674",

"balance": {

"amount": "15.0",

"currencyCode": "USD"

}

"userErrors": []

}