discountAutomaticAppUpdate - admin-graphql - MUTATION

Version: 2024-01

Description:

Updates an existing automatic discount that's managed by an app using [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Use this mutation when you need advanced, custom, or dynamic discount capabilities that aren't supported by [Shopify's native discount types](https://help.shopify.com/manual/discounts/discount-types). For example, use this mutation to update a new "Volume" discount type that applies a percentage off when customers purchase more than the minimum quantity of a product. For an example implementation, refer to [our tutorial](https://shopify.dev/docs/apps/build/discounts/build-discount-function). > Note: > To update code discounts with custom logic, use the [`discountCodeAppUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeAppUpdate) mutation instead.

Access Scopes

`write_discounts` access scope.

Arguments

• automaticAppDiscount: DiscountAutomaticAppInput! - The input fields required to update the automatic discount.
• id: ID! - The ID of the automatic discount to update.

Returns

• automaticAppDiscount: DiscountAutomaticApp The updated automatic discount that the app provides.
• userErrors: DiscountUserError! The list of errors that occurred from executing the mutation.

Examples

• Update an app automatic discount

          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 discountAutomaticAppUpdate($automaticAppDiscount: DiscountAutomaticAppInput!, $id: ID!) { discountAutomaticAppUpdate(automaticAppDiscount: $automaticAppDiscount, id: $id) { automaticAppDiscount { discountId title startsAt endsAt status appDiscountType { appKey functionId } combinesWith { orderDiscounts productDiscounts shippingDiscounts } } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/DiscountAutomaticNode/159339796\",\n    \"automaticAppDiscount\": {\n      \"title\": \"Take 5$ from order discount\",\n      \"endsAt\": \"2024-08-29T01:05:24Z\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation discountAutomaticAppUpdate($automaticAppDiscount: DiscountAutomaticAppInput!, $id: ID!) {\n      discountAutomaticAppUpdate(automaticAppDiscount: $automaticAppDiscount, id: $id) {\n        automaticAppDiscount {\n          discountId\n          title\n          startsAt\n          endsAt\n          status\n          appDiscountType {\n            appKey\n            functionId\n          }\n          combinesWith {\n            orderDiscounts\n            productDiscounts\n            shippingDiscounts\n          }\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/DiscountAutomaticNode/159339796\",\n      \"automaticAppDiscount\": {\n        \"title\": \"Take 5$ from order discount\",\n        \"endsAt\": \"2024-08-29T01:05:24Z\"\n      }\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 discountAutomaticAppUpdate($automaticAppDiscount: DiscountAutomaticAppInput!, $id: ID!) {\n    discountAutomaticAppUpdate(automaticAppDiscount: $automaticAppDiscount, id: $id) {\n      automaticAppDiscount {\n        discountId\n        title\n        startsAt\n        endsAt\n        status\n        appDiscountType {\n          appKey\n          functionId\n        }\n        combinesWith {\n          orderDiscounts\n          productDiscounts\n          shippingDiscounts\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/DiscountAutomaticNode/159339796\",\n  \"automaticAppDiscount\": {\n    \"title\": \"Take 5$ from order discount\",\n    \"endsAt\": \"2024-08-29T01:05:24Z\"\n  }\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 discountAutomaticAppUpdate($automaticAppDiscount: DiscountAutomaticAppInput!, $id: ID!) {\n    discountAutomaticAppUpdate(automaticAppDiscount: $automaticAppDiscount, id: $id) {\n      automaticAppDiscount {\n        discountId\n        title\n        startsAt\n        endsAt\n        status\n        appDiscountType {\n          appKey\n          functionId\n        }\n        combinesWith {\n          orderDiscounts\n          productDiscounts\n          shippingDiscounts\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/DiscountAutomaticNode/159339796\",\n  \"automaticAppDiscount\" => [\n    \"title\" => \"Take 5$ from order discount\",\n    \"endsAt\" => \"2024-08-29T01:05:24Z\",\n  ],\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 discountAutomaticAppUpdate($automaticAppDiscount: DiscountAutomaticAppInput!, $id: ID!) {\n    discountAutomaticAppUpdate(automaticAppDiscount: $automaticAppDiscount, id: $id) {\n      automaticAppDiscount {\n        discountId\n        title\n        startsAt\n        endsAt\n        status\n        appDiscountType {\n          appKey\n          functionId\n        }\n        combinesWith {\n          orderDiscounts\n          productDiscounts\n          shippingDiscounts\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/DiscountAutomaticNode/159339796\",\n      \"automaticAppDiscount\": {\n        \"title\": \"Take 5$ from order discount\",\n        \"endsAt\": \"2024-08-29T01:05:24Z\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation discountAutomaticAppUpdate($automaticAppDiscount: DiscountAutomaticAppInput!, $id: ID!) {\n  discountAutomaticAppUpdate(automaticAppDiscount: $automaticAppDiscount, id: $id) {\n    automaticAppDiscount {\n      discountId\n      title\n      startsAt\n      endsAt\n      status\n      appDiscountType {\n        appKey\n        functionId\n      }\n      combinesWith {\n        orderDiscounts\n        productDiscounts\n        shippingDiscounts\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/DiscountAutomaticNode/159339796",
    "automaticAppDiscount": {
      "title": "Take 5$ from order discount",
      "endsAt": "2024-08-29T01:05:24Z"
    }
  }

  response: {
    "data": {
      "discountAutomaticAppUpdate": {
        "automaticAppDiscount": {
          "discountId": "gid://shopify/DiscountAutomaticNode/159339796",
          "title": "Take 5$ from order discount",
          "startsAt": "2024-08-23T01:05:24Z",
          "endsAt": "2024-08-29T01:05:24Z",
          "status": "EXPIRED",
          "appDiscountType": {
            "appKey": "shopify-vm-test-app",
            "functionId": "16ffe691-6584-44ea-8396-b54c24dd033d"
          },
          "combinesWith": {
            "orderDiscounts": false,
            "productDiscounts": false,
            "shippingDiscounts": false
          }
        },
        "userErrors": []
      }
    }
  }