discountCodeDeactivate - admin-graphql - MUTATION

Version: 2024-10

Description:

Deactivates a code discount.

Access Scopes

Apps must have `write_discounts` access scope.

Arguments

• id: ID! - The ID of the code discount to deactivate.

Returns

• codeDiscountNode: DiscountCodeNode The deactivated code discount.
• userErrors: DiscountUserError! The list of errors that occurred from executing the mutation.

Examples

• Deactivate a code discount set to start in the future

          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 discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation discountCodeDeactivate($id: ID!) {\n      discountCodeDeactivate(id: $id) {\n        codeDiscountNode {\n          codeDiscount {\n            ... on DiscountCodeBasic {\n              title\n              status\n              startsAt\n              endsAt\n            }\n          }\n        }\n        userErrors {\n          field\n          code\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n    discountCodeDeactivate(id: $id) {\n      codeDiscountNode {\n        codeDiscount {\n          ... on DiscountCodeBasic {\n            title\n            status\n            startsAt\n            endsAt\n          }\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n    discountCodeDeactivate(id: $id) {\n      codeDiscountNode {\n        codeDiscount {\n          ... on DiscountCodeBasic {\n            title\n            status\n            startsAt\n            endsAt\n          }\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/DiscountCodeNode/206265824\",\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 discountCodeDeactivate($id: ID!) {\n    discountCodeDeactivate(id: $id) {\n      codeDiscountNode {\n        codeDiscount {\n          ... on DiscountCodeBasic {\n            title\n            status\n            startsAt\n            endsAt\n          }\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation discountCodeDeactivate($id: ID!) {\n  discountCodeDeactivate(id: $id) {\n    codeDiscountNode {\n      codeDiscount {\n        ... on DiscountCodeBasic {\n          title\n          status\n          startsAt\n          endsAt\n        }\n      }\n    }\n    userErrors {\n      field\n      code\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/DiscountCodeNode/206265824"
  }

  response: {
    "data": {
      "discountCodeDeactivate": {
        "codeDiscountNode": {
          "codeDiscount": {
            "title": "percentage_off_code",
            "status": "EXPIRED",
            "startsAt": "2024-09-12T01:06:40Z",
            "endsAt": "2024-09-12T01:06:40Z"
          }
        },
        "userErrors": []
      }
    }
  }

  Deactivate an active code discount

          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 discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation discountCodeDeactivate($id: ID!) {\n      discountCodeDeactivate(id: $id) {\n        codeDiscountNode {\n          codeDiscount {\n            ... on DiscountCodeBasic {\n              title\n              status\n              startsAt\n              endsAt\n            }\n          }\n        }\n        userErrors {\n          field\n          code\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n    discountCodeDeactivate(id: $id) {\n      codeDiscountNode {\n        codeDiscount {\n          ... on DiscountCodeBasic {\n            title\n            status\n            startsAt\n            endsAt\n          }\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n    discountCodeDeactivate(id: $id) {\n      codeDiscountNode {\n        codeDiscount {\n          ... on DiscountCodeBasic {\n            title\n            status\n            startsAt\n            endsAt\n          }\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/DiscountCodeNode/206265824\",\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 discountCodeDeactivate($id: ID!) {\n    discountCodeDeactivate(id: $id) {\n      codeDiscountNode {\n        codeDiscount {\n          ... on DiscountCodeBasic {\n            title\n            status\n            startsAt\n            endsAt\n          }\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation discountCodeDeactivate($id: ID!) {\n  discountCodeDeactivate(id: $id) {\n    codeDiscountNode {\n      codeDiscount {\n        ... on DiscountCodeBasic {\n          title\n          status\n          startsAt\n          endsAt\n        }\n      }\n    }\n    userErrors {\n      field\n      code\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/DiscountCodeNode/206265824"
  }

  response: {
    "data": {
      "discountCodeDeactivate": {
        "codeDiscountNode": {
          "codeDiscount": {
            "title": "percentage_off_code",
            "status": "EXPIRED",
            "startsAt": "2024-09-03T01:05:24Z",
            "endsAt": "2024-09-12T01:06:40Z"
          }
        },
        "userErrors": []
      }
    }
  }