Anchor to section titled 'undefined'

discountAutomaticAppUpdate
mutation

Requires write_discounts access scope.

Updates an automatic app discount.

Anchor to section titled 'Arguments'

Arguments

Anchor to automaticAppDiscount
automaticAppDiscount
DiscountAutomaticAppInput!
required

The input fields required to update the automatic app discount.

Anchor to id
id
ID!
required

The ID of the automatic app discount to update.

Was this section helpful?
Anchor to section titled 'DiscountAutomaticAppUpdatePayload returns'

DiscountAutomaticAppUpdatePayload returns

Anchor to DiscountAutomaticAppUpdatePayload.automaticAppDiscount
automaticAppDiscount
DiscountAutomaticApp

The updated automatic app discount.

Anchor to DiscountAutomaticAppUpdatePayload.userErrors
userErrors
[DiscountUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Hide code
DescriptionCopy
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
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"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 } } }",
 "variables": {
    "id": "gid://shopify/DiscountAutomaticNode/159339796",
    "automaticAppDiscount": {
      "title": "Take 5$ from order discount",
      "endsAt": "2024-08-29T01:05:24Z"
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  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
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/DiscountAutomaticNode/159339796",
      "automaticAppDiscount": {
        "title": "Take 5$ from order discount",
        "endsAt": "2024-08-29T01:05:24Z"
      }
    },
  },
);

const data = await response.json();

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 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
      }
    }
  }
QUERY

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

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

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "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
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/DiscountAutomaticNode/159339796",
      "automaticAppDiscount": {
        "title": "Take 5$ from order discount",
        "endsAt": "2024-08-29T01:05:24Z"
      }
    },
  },
});

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<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
      }
    }
  }
QUERY;

$variables = [
  "id" => "gid://shopify/DiscountAutomaticNode/159339796",
  "automaticAppDiscount" => [
    "title" => "Take 5$ from order discount",
    "endsAt" => "2024-08-29T01:05:24Z",
  ],
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "id": "gid://shopify/DiscountAutomaticNode/159339796",
  "automaticAppDiscount": {
    "title": "Take 5$ from order discount",
    "endsAt": "2024-08-29T01:05:24Z"
  }
}
Hide code
Response
JSON
{
  "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": []
  }
}