Choose a version:

Anchor to giftCardSendNotificationToCustomer

giftCardSendNotificationToCustomer

mutation

Requires write_gift_cards access scope.

Sends a notification to the customer who purchased a gift card, including the gift card details and code. The notification is delivered using the customer's available contact method. Use this to resend the purchase confirmation or remind the purchaser about a gift card they bought.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the gift card to send.

Was this section helpful?

Anchor to GiftCardSendNotificationToCustomerPayload returnsGiftCardSendNotificationToCustomerPayload returns

Anchor to giftCardgiftCard •GiftCard: The gift card that was sent.
Anchor to userErrorsuserErrors •[GiftCardSendNotificationToCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Send a notification to a gift card's customer

Query

mutation giftCardSendNotificationToCustomer($id: ID!) {
  giftCardSendNotificationToCustomer(id: $id) {
    giftCard {
      id
      customer {
        id
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}

Variables

{
  "id": "gid://shopify/GiftCard/698360200"
}

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 giftCardSendNotificationToCustomer($id: ID!) { giftCardSendNotificationToCustomer(id: $id) { giftCard { id customer { id } } userErrors { message field code } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/698360200"
  }
}'

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 giftCardSendNotificationToCustomer($id: ID!) {
    giftCardSendNotificationToCustomer(id: $id) {
      giftCard {
        id
        customer {
          id
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/698360200"
    },
  },
  );
  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 giftCardSendNotificationToCustomer($id: ID!) {
    giftCardSendNotificationToCustomer(id: $id) {
      giftCard {
        id
        customer {
          id
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/698360200"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation giftCardSendNotificationToCustomer($id: ID!) {
      giftCardSendNotificationToCustomer(id: $id) {
        giftCard {
          id
          customer {
            id
          }
        }
        userErrors {
          message
          field
          code
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/698360200"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation giftCardSendNotificationToCustomer($id: ID!) {
  giftCardSendNotificationToCustomer(id: $id) {
    giftCard {
      id
      customer {
        id
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/GiftCard/698360200"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation giftCardSendNotificationToCustomer($id: ID!) {
        giftCardSendNotificationToCustomer(id: $id) {
          giftCard {
            id
            customer {
              id
            }
          }
          userErrors {
            message
            field
            code
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/GiftCard/698360200"
    },
  }),
});

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

Response

{
  "giftCardSendNotificationToCustomer": {
    "giftCard": {
      "id": "gid://shopify/GiftCard/698360200",
      "customer": {
        "id": "gid://shopify/Customer/649509010"
      }
    },
    "userErrors": []
  }
}

giftCardSendNotificationToCustomer 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 giftCardSendNotificationToCustomer($id: ID!) {

giftCardSendNotificationToCustomer(id: $id) {

giftCard {

customer {

}

userErrors {

message

field

code

}

}`,

{

variables: {

"id": "gid://shopify/GiftCard/698360200"

);

const json = await response.json();

return json.data;

}

GQL

mutation giftCardSendNotificationToCustomer($id: ID!) {
  giftCardSendNotificationToCustomer(id: $id) {
    giftCard {
      id
      customer {
        id
      }
    }
    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 giftCardSendNotificationToCustomer($id: ID!) { giftCardSendNotificationToCustomer(id: $id) { giftCard { id customer { id } } userErrors { message field code } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/698360200"
  }
}'

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 giftCardSendNotificationToCustomer($id: ID!) {
    giftCardSendNotificationToCustomer(id: $id) {
      giftCard {
        id
        customer {
          id
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/698360200"
    },
  },
  );
  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 giftCardSendNotificationToCustomer($id: ID!) {
      giftCardSendNotificationToCustomer(id: $id) {
        giftCard {
          id
          customer {
            id
          }
        }
        userErrors {
          message
          field
          code
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/698360200"
    },
  },
});

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 giftCardSendNotificationToCustomer($id: ID!) {
    giftCardSendNotificationToCustomer(id: $id) {
      giftCard {
        id
        customer {
          id
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/698360200"
}

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

Shopify CLI

shopify app execute \
--query \
'mutation giftCardSendNotificationToCustomer($id: ID!) {
  giftCardSendNotificationToCustomer(id: $id) {
    giftCard {
      id
      customer {
        id
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/GiftCard/698360200"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation giftCardSendNotificationToCustomer($id: ID!) {
        giftCardSendNotificationToCustomer(id: $id) {
          giftCard {
            id
            customer {
              id
            }
          }
          userErrors {
            message
            field
            code
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/GiftCard/698360200"
    },
  }),
});

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

Input variables

JSON

{

"id": "gid://shopify/GiftCard/698360200"

}

Response

JSON

{

"giftCardSendNotificationToCustomer": {

"giftCard": {

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

"customer": {

"id": "gid://shopify/Customer/649509010"

}

"userErrors": []

}