giftCardDisable - admin-graphql - MUTATION

Version: 2024-01

Description:

Disable a gift card. A disabled gift card cannot be used by a customer. A disabled gift card cannot be re-enabled.

Access Scopes

`write_gift_cards` access scope.

Arguments

• id: ID! - The ID of the gift card to disable.

Returns

• giftCard: GiftCard The disabled gift card.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Disable a gift card by ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation giftCardDisable($id: ID!) { giftCardDisable(id: $id) { userErrors { message field } giftCard { id enabled } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/GiftCard/63396415\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation giftCardDisable($id: ID!) {\n      giftCardDisable(id: $id) {\n        userErrors {\n          message\n          field\n        }\n        giftCard {\n          id\n          enabled\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/GiftCard/63396415\"\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 giftCardDisable($id: ID!) {\n    giftCardDisable(id: $id) {\n      userErrors {\n        message\n        field\n      }\n      giftCard {\n        id\n        enabled\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/GiftCard/63396415\"\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 = <<<QUERY\n  mutation giftCardDisable($id: ID!) {\n    giftCardDisable(id: $id) {\n      userErrors {\n        message\n        field\n      }\n      giftCard {\n        id\n        enabled\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/GiftCard/63396415\",\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 giftCardDisable($id: ID!) {\n    giftCardDisable(id: $id) {\n      userErrors {\n        message\n        field\n      }\n      giftCard {\n        id\n        enabled\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/GiftCard/63396415\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation giftCardDisable($id: ID!) {\n  giftCardDisable(id: $id) {\n    userErrors {\n      message\n      field\n    }\n    giftCard {\n      id\n      enabled\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/GiftCard/63396415"
  }

  response: {
    "data": {
      "giftCardDisable": {
        "userErrors": [],
        "giftCard": {
          "id": "gid://shopify/GiftCard/63396415",
          "enabled": false
        }
      }
    }
  }