discountCodeBulkDeactivate - admin-graphql - MUTATION

Version: 2024-10

Description:

Asynchronously deactivate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.

Access Scopes

Apps must have `write_discounts` access scope.

Arguments

• ids: ID - The IDs of the code discounts to deactivate.
• savedSearchId: ID - The ID of the saved search.
• search: String - The search query for filtering code discounts. For more information on the list of supported fields and search syntax, refer to the [CodeDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/codeDiscountNodes#argument-codediscountnodes-query).

Returns

• job: Job The asynchronous job that deactivates the code discounts.
• userErrors: DiscountUserError! The list of errors that occurred from executing the mutation.

Examples

• Asynchronously deactivate code discounts in bulk using a search filter

          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 discountCodeBulkDeactivate($search: String) { discountCodeBulkDeactivate(search: $search) { job { id } userErrors { code field message } } }\",\n \"variables\": {\n    \"search\": \"discount_type:percentage ends_at:past_week\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation discountCodeBulkDeactivate($search: String) {\n      discountCodeBulkDeactivate(search: $search) {\n        job {\n          id\n        }\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"search\": \"discount_type:percentage ends_at:past_week\"\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 discountCodeBulkDeactivate($search: String) {\n    discountCodeBulkDeactivate(search: $search) {\n      job {\n        id\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"search\": \"discount_type:percentage ends_at:past_week\"\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 = << \"discount_type:percentage ends_at:past_week\",\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 discountCodeBulkDeactivate($search: String) {\n    discountCodeBulkDeactivate(search: $search) {\n      job {\n        id\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"search\": \"discount_type:percentage ends_at:past_week\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation discountCodeBulkDeactivate($search: String) {\n  discountCodeBulkDeactivate(search: $search) {\n    job {\n      id\n    }\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "search": "discount_type:percentage ends_at:past_week"
  }

  response: {
    "data": {
      "discountCodeBulkDeactivate": {
        "job": {
          "id": "gid://shopify/Job/18cd2ec6-34b1-4c8c-a156-9b467a6a4c3d"
        },
        "userErrors": []
      }
    }
  }

  Using more than one targeting argument 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 discountCodeBulkDeactivate($search: String, $ids: [ID!]) { discountCodeBulkDeactivate(search: $search, ids: $ids) { job { id } userErrors { code field message } } }\",\n \"variables\": {\n    \"ids\": [\n      \"gid://shopify/DiscountCodeNode/1\"\n    ],\n    \"search\": \"discount_type:bxgy\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation discountCodeBulkDeactivate($search: String, $ids: [ID!]) {\n      discountCodeBulkDeactivate(search: $search, ids: $ids) {\n        job {\n          id\n        }\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"ids\": [\n        \"gid://shopify/DiscountCodeNode/1\"\n      ],\n      \"search\": \"discount_type:bxgy\"\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 discountCodeBulkDeactivate($search: String, $ids: [ID!]) {\n    discountCodeBulkDeactivate(search: $search, ids: $ids) {\n      job {\n        id\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"ids\": [\"gid://shopify/DiscountCodeNode/1\"],\n  \"search\": \"discount_type:bxgy\"\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/DiscountCodeNode/1\"],\n  \"search\" => \"discount_type:bxgy\",\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 discountCodeBulkDeactivate($search: String, $ids: [ID!]) {\n    discountCodeBulkDeactivate(search: $search, ids: $ids) {\n      job {\n        id\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"ids\": [\n        \"gid://shopify/DiscountCodeNode/1\"\n      ],\n      \"search\": \"discount_type:bxgy\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation discountCodeBulkDeactivate($search: String, $ids: [ID!]) {\n  discountCodeBulkDeactivate(search: $search, ids: $ids) {\n    job {\n      id\n    }\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "ids": [
      "gid://shopify/DiscountCodeNode/1"
    ],
    "search": "discount_type:bxgy"
  }

  response: {
    "data": {
      "discountCodeBulkDeactivate": {
        "job": null,
        "userErrors": [
          {
            "code": "TOO_MANY_ARGUMENTS",
            "field": null,
            "message": "Only one of 'ids', 'search' or 'saved_search_id' is allowed."
          }
        ]
      }
    }
  }