Choose a version:

discountAutomaticAppCreate

mutation

Requires write_discounts access scope.

Creates an automatic discount that's managed by an app. Use this mutation with Shopify Functions when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.

For example, use this mutation to create an automatic discount using an app's "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.

Note

To create code discounts with custom logic, use the discountCodeAppCreate mutation.

Anchor to Arguments

Arguments

Anchor to automaticAppDiscountautomaticAppDiscount

•DiscountAutomaticAppInput!

required

The input data used to create the automatic discount.

Was this section helpful?

Anchor to DiscountAutomaticAppCreatePayload returnsDiscountAutomaticAppCreatePayload returns

Anchor to automaticAppDiscountautomaticAppDiscount •DiscountAutomaticApp: The automatic discount that the app manages.
Anchor to userErrorsuserErrors •[DiscountUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Create a non-combinable automatic order discount that's managed by an app

Description

Create an automatic discount that's managed by an app using [Shopify Functions](https://shopify.dev/docs/apps/build/functions). This example shows how to create an automatic discount that takes $5 off the order subtotal and can't be [combined](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) with other discounts.

Query

mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
  discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
    userErrors {
      field
      message
    }
    automaticAppDiscount {
      discountId
      title
      startsAt
      endsAt
      status
      appDiscountType {
        appKey
        functionId
      }
      combinesWith {
        orderDiscounts
        productDiscounts
        shippingDiscounts
      }
    }
  }
}

Variables

{
  "automaticAppDiscount": {
    "title": "$5 discount",
    "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
    "startsAt": "2025-02-02T17:09:21Z",
    "endsAt": "2025-02-02T17:09:21Z",
    "combinesWith": {
      "orderDiscounts": false,
      "productDiscounts": false,
      "shippingDiscounts": false
    },
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) { discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) { userErrors { field message } automaticAppDiscount { discountId title startsAt endsAt status appDiscountType { appKey functionId } combinesWith { orderDiscounts productDiscounts shippingDiscounts } } } }",
 "variables": {
    "automaticAppDiscount": {
      "title": "$5 discount",
      "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
      "startsAt": "2025-02-02T17:09:21Z",
      "endsAt": "2025-02-02T17:09:21Z",
      "combinesWith": {
        "orderDiscounts": false,
        "productDiscounts": false,
        "shippingDiscounts": false
      },
      "metafields": [
        {
          "namespace": "default",
          "key": "function-configuration",
          "type": "json",
          "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
    discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
      userErrors {
        field
        message
      }
      automaticAppDiscount {
        discountId
        title
        startsAt
        endsAt
        status
        appDiscountType {
          appKey
          functionId
        }
        combinesWith {
          orderDiscounts
          productDiscounts
          shippingDiscounts
        }
      }
    }
  }`,
  {
    variables: {
        "automaticAppDiscount": {
            "title": "$5 discount",
            "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
            "startsAt": "2025-02-02T17:09:21Z",
            "endsAt": "2025-02-02T17:09:21Z",
            "combinesWith": {
                "orderDiscounts": false,
                "productDiscounts": false,
                "shippingDiscounts": false
            },
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
    discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
      userErrors {
        field
        message
      }
      automaticAppDiscount {
        discountId
        title
        startsAt
        endsAt
        status
        appDiscountType {
          appKey
          functionId
        }
        combinesWith {
          orderDiscounts
          productDiscounts
          shippingDiscounts
        }
      }
    }
  }
QUERY

variables = {
  "automaticAppDiscount": {
    "title": "$5 discount",
    "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
    "startsAt": "2025-02-02T17:09:21Z",
    "endsAt": "2025-02-02T17:09:21Z",
    "combinesWith": {
      "orderDiscounts": false,
      "productDiscounts": false,
      "shippingDiscounts": false
    },
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
      discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
        userErrors {
          field
          message
        }
        automaticAppDiscount {
          discountId
          title
          startsAt
          endsAt
          status
          appDiscountType {
            appKey
            functionId
          }
          combinesWith {
            orderDiscounts
            productDiscounts
            shippingDiscounts
          }
        }
      }
    }`,
    "variables": {
        "automaticAppDiscount": {
            "title": "$5 discount",
            "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
            "startsAt": "2025-02-02T17:09:21Z",
            "endsAt": "2025-02-02T17:09:21Z",
            "combinesWith": {
                "orderDiscounts": false,
                "productDiscounts": false,
                "shippingDiscounts": false
            },
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
  discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
    userErrors {
      field
      message
    }
    automaticAppDiscount {
      discountId
      title
      startsAt
      endsAt
      status
      appDiscountType {
        appKey
        functionId
      }
      combinesWith {
        orderDiscounts
        productDiscounts
        shippingDiscounts
      }
    }
  }
}' \
--variables \
'{
  "automaticAppDiscount": {
    "title": "$5 discount",
    "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
    "startsAt": "2025-02-02T17:09:21Z",
    "endsAt": "2025-02-02T17:09:21Z",
    "combinesWith": {
      "orderDiscounts": false,
      "productDiscounts": false,
      "shippingDiscounts": false
    },
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
        discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
          userErrors {
            field
            message
          }
          automaticAppDiscount {
            discountId
            title
            startsAt
            endsAt
            status
            appDiscountType {
              appKey
              functionId
            }
            combinesWith {
              orderDiscounts
              productDiscounts
              shippingDiscounts
            }
          }
        }
      }
    `,
    variables: {
        "automaticAppDiscount": {
            "title": "$5 discount",
            "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
            "startsAt": "2025-02-02T17:09:21Z",
            "endsAt": "2025-02-02T17:09:21Z",
            "combinesWith": {
                "orderDiscounts": false,
                "productDiscounts": false,
                "shippingDiscounts": false
            },
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountAutomaticAppCreate": {
    "userErrors": [],
    "automaticAppDiscount": {
      "discountId": "gid://shopify/DiscountAutomaticNode/1057856655",
      "title": "$5 discount",
      "startsAt": "2025-02-02T17:09:21Z",
      "endsAt": "2025-02-02T17:09:21Z",
      "status": "EXPIRED",
      "appDiscountType": {
        "appKey": "shopify-web",
        "functionId": "13d358d1-2a5b-4a39-a6f9-8f53394e440d"
      },
      "combinesWith": {
        "orderDiscounts": false,
        "productDiscounts": false,
        "shippingDiscounts": false
      }
    }
  }
}

Create an automatic app product discount for a customer segment

Description

Create an automatic discount that's managed by an app using [Shopify Functions](https://shopify.dev/docs/apps/build/functions). This example shows how to create an automatic discount that takes $10 off a specific product and applies only to a specific customer segment.

Query

mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
  discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
    userErrors {
      field
      message
    }
    automaticAppDiscount {
      discountId
      title
      startsAt
      endsAt
      status
      context {
        ... on DiscountCustomerSegments {
          segments {
            id
          }
        }
      }
      appDiscountType {
        appKey
        functionId
      }
    }
  }
}

Variables

{
  "automaticAppDiscount": {
    "title": "Product discount $10 off",
    "functionId": "3f4c5bfc-7840-4e16-bb09-2389ac44e76a",
    "startsAt": "2026-04-29T02:45:06-04:00",
    "context": {
      "customerSegments": {
        "add": [
          "gid://shopify/Segment/8961721"
        ]
      }
    },
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) { discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) { userErrors { field message } automaticAppDiscount { discountId title startsAt endsAt status context { ... on DiscountCustomerSegments { segments { id } } } appDiscountType { appKey functionId } } } }",
 "variables": {
    "automaticAppDiscount": {
      "title": "Product discount $10 off",
      "functionId": "3f4c5bfc-7840-4e16-bb09-2389ac44e76a",
      "startsAt": "2026-04-29T02:45:06-04:00",
      "context": {
        "customerSegments": {
          "add": [
            "gid://shopify/Segment/8961721"
          ]
        }
      },
      "metafields": [
        {
          "namespace": "default",
          "key": "function-configuration",
          "type": "json",
          "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
    discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
      userErrors {
        field
        message
      }
      automaticAppDiscount {
        discountId
        title
        startsAt
        endsAt
        status
        context {
          ... on DiscountCustomerSegments {
            segments {
              id
            }
          }
        }
        appDiscountType {
          appKey
          functionId
        }
      }
    }
  }`,
  {
    variables: {
        "automaticAppDiscount": {
            "title": "Product discount $10 off",
            "functionId": "3f4c5bfc-7840-4e16-bb09-2389ac44e76a",
            "startsAt": "2026-04-29T02:45:06-04:00",
            "context": {
                "customerSegments": {
                    "add": [
                        "gid://shopify/Segment/8961721"
                    ]
                }
            },
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
    discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
      userErrors {
        field
        message
      }
      automaticAppDiscount {
        discountId
        title
        startsAt
        endsAt
        status
        context {
          ... on DiscountCustomerSegments {
            segments {
              id
            }
          }
        }
        appDiscountType {
          appKey
          functionId
        }
      }
    }
  }
QUERY

variables = {
  "automaticAppDiscount": {
    "title": "Product discount $10 off",
    "functionId": "3f4c5bfc-7840-4e16-bb09-2389ac44e76a",
    "startsAt": "2026-04-29T02:45:06-04:00",
    "context": {
      "customerSegments": {
        "add": [
          "gid://shopify/Segment/8961721"
        ]
      }
    },
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
      discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
        userErrors {
          field
          message
        }
        automaticAppDiscount {
          discountId
          title
          startsAt
          endsAt
          status
          context {
            ... on DiscountCustomerSegments {
              segments {
                id
              }
            }
          }
          appDiscountType {
            appKey
            functionId
          }
        }
      }
    }`,
    "variables": {
        "automaticAppDiscount": {
            "title": "Product discount $10 off",
            "functionId": "3f4c5bfc-7840-4e16-bb09-2389ac44e76a",
            "startsAt": "2026-04-29T02:45:06-04:00",
            "context": {
                "customerSegments": {
                    "add": [
                        "gid://shopify/Segment/8961721"
                    ]
                }
            },
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
  discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
    userErrors {
      field
      message
    }
    automaticAppDiscount {
      discountId
      title
      startsAt
      endsAt
      status
      context {
        ... on DiscountCustomerSegments {
          segments {
            id
          }
        }
      }
      appDiscountType {
        appKey
        functionId
      }
    }
  }
}' \
--variables \
'{
  "automaticAppDiscount": {
    "title": "Product discount $10 off",
    "functionId": "3f4c5bfc-7840-4e16-bb09-2389ac44e76a",
    "startsAt": "2026-04-29T02:45:06-04:00",
    "context": {
      "customerSegments": {
        "add": [
          "gid://shopify/Segment/8961721"
        ]
      }
    },
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
        discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
          userErrors {
            field
            message
          }
          automaticAppDiscount {
            discountId
            title
            startsAt
            endsAt
            status
            context {
              ... on DiscountCustomerSegments {
                segments {
                  id
                }
              }
            }
            appDiscountType {
              appKey
              functionId
            }
          }
        }
      }
    `,
    variables: {
        "automaticAppDiscount": {
            "title": "Product discount $10 off",
            "functionId": "3f4c5bfc-7840-4e16-bb09-2389ac44e76a",
            "startsAt": "2026-04-29T02:45:06-04:00",
            "context": {
                "customerSegments": {
                    "add": [
                        "gid://shopify/Segment/8961721"
                    ]
                }
            },
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountAutomaticAppCreate": {
    "userErrors": [],
    "automaticAppDiscount": {
      "discountId": "gid://shopify/DiscountAutomaticNode/1057856800",
      "title": "Product discount $10 off",
      "startsAt": "2026-04-29T06:45:06Z",
      "endsAt": null,
      "status": "ACTIVE",
      "context": {
        "segments": [
          {
            "id": "gid://shopify/Segment/8961721"
          }
        ]
      },
      "appDiscountType": {
        "appKey": "shopify-web",
        "functionId": "3f4c5bfc-7840-4e16-bb09-2389ac44e76a"
      }
    }
  }
}

Create an automatic product discount that's managed by an app

Description

Query

mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
  discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
    userErrors {
      field
      message
    }
    automaticAppDiscount {
      discountId
      title
      startsAt
      endsAt
      status
      appDiscountType {
        appKey
        functionId
      }
    }
  }
}

Variables

{
  "automaticAppDiscount": {
    "title": "Product discount $10 off",
    "functionId": "677bc937-7dce-4fe4-8e8d-076c391d3e53",
    "startsAt": "2025-01-01T00:00:00Z",
    "endsAt": "2025-12-31T23:59:59Z",
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) { discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) { userErrors { field message } automaticAppDiscount { discountId title startsAt endsAt status appDiscountType { appKey functionId } } } }",
 "variables": {
    "automaticAppDiscount": {
      "title": "Product discount $10 off",
      "functionId": "677bc937-7dce-4fe4-8e8d-076c391d3e53",
      "startsAt": "2025-01-01T00:00:00Z",
      "endsAt": "2025-12-31T23:59:59Z",
      "metafields": [
        {
          "namespace": "default",
          "key": "function-configuration",
          "type": "json",
          "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
    discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
      userErrors {
        field
        message
      }
      automaticAppDiscount {
        discountId
        title
        startsAt
        endsAt
        status
        appDiscountType {
          appKey
          functionId
        }
      }
    }
  }`,
  {
    variables: {
        "automaticAppDiscount": {
            "title": "Product discount $10 off",
            "functionId": "677bc937-7dce-4fe4-8e8d-076c391d3e53",
            "startsAt": "2025-01-01T00:00:00Z",
            "endsAt": "2025-12-31T23:59:59Z",
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
    discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
      userErrors {
        field
        message
      }
      automaticAppDiscount {
        discountId
        title
        startsAt
        endsAt
        status
        appDiscountType {
          appKey
          functionId
        }
      }
    }
  }
QUERY

variables = {
  "automaticAppDiscount": {
    "title": "Product discount $10 off",
    "functionId": "677bc937-7dce-4fe4-8e8d-076c391d3e53",
    "startsAt": "2025-01-01T00:00:00Z",
    "endsAt": "2025-12-31T23:59:59Z",
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
      discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
        userErrors {
          field
          message
        }
        automaticAppDiscount {
          discountId
          title
          startsAt
          endsAt
          status
          appDiscountType {
            appKey
            functionId
          }
        }
      }
    }`,
    "variables": {
        "automaticAppDiscount": {
            "title": "Product discount $10 off",
            "functionId": "677bc937-7dce-4fe4-8e8d-076c391d3e53",
            "startsAt": "2025-01-01T00:00:00Z",
            "endsAt": "2025-12-31T23:59:59Z",
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
  discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
    userErrors {
      field
      message
    }
    automaticAppDiscount {
      discountId
      title
      startsAt
      endsAt
      status
      appDiscountType {
        appKey
        functionId
      }
    }
  }
}' \
--variables \
'{
  "automaticAppDiscount": {
    "title": "Product discount $10 off",
    "functionId": "677bc937-7dce-4fe4-8e8d-076c391d3e53",
    "startsAt": "2025-01-01T00:00:00Z",
    "endsAt": "2025-12-31T23:59:59Z",
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
        discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
          userErrors {
            field
            message
          }
          automaticAppDiscount {
            discountId
            title
            startsAt
            endsAt
            status
            appDiscountType {
              appKey
              functionId
            }
          }
        }
      }
    `,
    variables: {
        "automaticAppDiscount": {
            "title": "Product discount $10 off",
            "functionId": "677bc937-7dce-4fe4-8e8d-076c391d3e53",
            "startsAt": "2025-01-01T00:00:00Z",
            "endsAt": "2025-12-31T23:59:59Z",
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 10}},\n    \"targets\": [{\"productVariant\": {\"id\": \"gid://shopify/ProductVariant/12345\"}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountAutomaticAppCreate": {
    "userErrors": [],
    "automaticAppDiscount": {
      "discountId": "gid://shopify/DiscountAutomaticNode/1057856654",
      "title": "Product discount $10 off",
      "startsAt": "2025-01-01T00:00:00Z",
      "endsAt": "2025-12-31T23:59:59Z",
      "status": "ACTIVE",
      "appDiscountType": {
        "appKey": "shopify-web",
        "functionId": "677bc937-7dce-4fe4-8e8d-076c391d3e53"
      }
    }
  }
}

discountAutomaticAppCreate reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {

discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {

userErrors {

field

message

}

automaticAppDiscount {

discountId

title

startsAt

endsAt

status

appDiscountType {

appKey

functionId

}

combinesWith {

orderDiscounts

productDiscounts

shippingDiscounts

}

}`,

{

variables: {

"automaticAppDiscount": {

"title": "$5 discount",

"functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",

"startsAt": "2025-02-02T17:09:21Z",

"endsAt": "2025-02-02T17:09:21Z",

"combinesWith": {

"orderDiscounts": false,

"productDiscounts": false,

"shippingDiscounts": false

"metafields": [

{

"namespace": "default",

"key": "function-configuration",

"type": "json",

"value": "{\n \"discounts\": [{\n \"value\": {\"fixedAmount\": {\"amount\": 5}},\n \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n }],\n \"discountApplicationStrategy\": \"FIRST\"\n}"

}

]

}

);

const json = await response.json();

return json.data;

}

GQL

mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
  discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
    userErrors {
      field
      message
    }
    automaticAppDiscount {
      discountId
      title
      startsAt
      endsAt
      status
      appDiscountType {
        appKey
        functionId
      }
      combinesWith {
        orderDiscounts
        productDiscounts
        shippingDiscounts
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) { discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) { userErrors { field message } automaticAppDiscount { discountId title startsAt endsAt status appDiscountType { appKey functionId } combinesWith { orderDiscounts productDiscounts shippingDiscounts } } } }",
 "variables": {
    "automaticAppDiscount": {
      "title": "$5 discount",
      "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
      "startsAt": "2025-02-02T17:09:21Z",
      "endsAt": "2025-02-02T17:09:21Z",
      "combinesWith": {
        "orderDiscounts": false,
        "productDiscounts": false,
        "shippingDiscounts": false
      },
      "metafields": [
        {
          "namespace": "default",
          "key": "function-configuration",
          "type": "json",
          "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
    discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
      userErrors {
        field
        message
      }
      automaticAppDiscount {
        discountId
        title
        startsAt
        endsAt
        status
        appDiscountType {
          appKey
          functionId
        }
        combinesWith {
          orderDiscounts
          productDiscounts
          shippingDiscounts
        }
      }
    }
  }`,
  {
    variables: {
        "automaticAppDiscount": {
            "title": "$5 discount",
            "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
            "startsAt": "2025-02-02T17:09:21Z",
            "endsAt": "2025-02-02T17:09:21Z",
            "combinesWith": {
                "orderDiscounts": false,
                "productDiscounts": false,
                "shippingDiscounts": false
            },
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
      discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
        userErrors {
          field
          message
        }
        automaticAppDiscount {
          discountId
          title
          startsAt
          endsAt
          status
          appDiscountType {
            appKey
            functionId
          }
          combinesWith {
            orderDiscounts
            productDiscounts
            shippingDiscounts
          }
        }
      }
    }`,
    "variables": {
        "automaticAppDiscount": {
            "title": "$5 discount",
            "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
            "startsAt": "2025-02-02T17:09:21Z",
            "endsAt": "2025-02-02T17:09:21Z",
            "combinesWith": {
                "orderDiscounts": false,
                "productDiscounts": false,
                "shippingDiscounts": false
            },
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  },
});

Ruby

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 discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
    discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
      userErrors {
        field
        message
      }
      automaticAppDiscount {
        discountId
        title
        startsAt
        endsAt
        status
        appDiscountType {
          appKey
          functionId
        }
        combinesWith {
          orderDiscounts
          productDiscounts
          shippingDiscounts
        }
      }
    }
  }
QUERY

variables = {
  "automaticAppDiscount": {
    "title": "$5 discount",
    "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
    "startsAt": "2025-02-02T17:09:21Z",
    "endsAt": "2025-02-02T17:09:21Z",
    "combinesWith": {
      "orderDiscounts": false,
      "productDiscounts": false,
      "shippingDiscounts": false
    },
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}

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

Shopify CLI

shopify app execute \
--query \
'mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
  discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
    userErrors {
      field
      message
    }
    automaticAppDiscount {
      discountId
      title
      startsAt
      endsAt
      status
      appDiscountType {
        appKey
        functionId
      }
      combinesWith {
        orderDiscounts
        productDiscounts
        shippingDiscounts
      }
    }
  }
}' \
--variables \
'{
  "automaticAppDiscount": {
    "title": "$5 discount",
    "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
    "startsAt": "2025-02-02T17:09:21Z",
    "endsAt": "2025-02-02T17:09:21Z",
    "combinesWith": {
      "orderDiscounts": false,
      "productDiscounts": false,
      "shippingDiscounts": false
    },
    "metafields": [
      {
        "namespace": "default",
        "key": "function-configuration",
        "type": "json",
        "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
      }
    ]
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation discountAutomaticAppCreate($automaticAppDiscount: DiscountAutomaticAppInput!) {
        discountAutomaticAppCreate(automaticAppDiscount: $automaticAppDiscount) {
          userErrors {
            field
            message
          }
          automaticAppDiscount {
            discountId
            title
            startsAt
            endsAt
            status
            appDiscountType {
              appKey
              functionId
            }
            combinesWith {
              orderDiscounts
              productDiscounts
              shippingDiscounts
            }
          }
        }
      }
    `,
    variables: {
        "automaticAppDiscount": {
            "title": "$5 discount",
            "functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",
            "startsAt": "2025-02-02T17:09:21Z",
            "endsAt": "2025-02-02T17:09:21Z",
            "combinesWith": {
                "orderDiscounts": false,
                "productDiscounts": false,
                "shippingDiscounts": false
            },
            "metafields": [
                {
                    "namespace": "default",
                    "key": "function-configuration",
                    "type": "json",
                    "value": "{\n  \"discounts\": [{\n    \"value\": {\"fixedAmount\": {\"amount\": 5}},\n    \"targets\": [{\"orderSubtotal\": {\"excludedVariantIds\": []}}]\n  }],\n  \"discountApplicationStrategy\": \"FIRST\"\n}"
                }
            ]
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"automaticAppDiscount": {

"title": "$5 discount",

"functionId": "a3cdef66-d84a-4254-9216-b6dd723005ad",

"startsAt": "2025-02-02T17:09:21Z",

"endsAt": "2025-02-02T17:09:21Z",

"combinesWith": {

"orderDiscounts": false,

"productDiscounts": false,

"shippingDiscounts": false

"metafields": [

{

"namespace": "default",

"key": "function-configuration",

"type": "json",

}

]

}

Response

JSON

{

"discountAutomaticAppCreate": {

"userErrors": [],

"automaticAppDiscount": {

"discountId": "gid://shopify/DiscountAutomaticNode/1057856655",

"title": "$5 discount",

"startsAt": "2025-02-02T17:09:21Z",

"endsAt": "2025-02-02T17:09:21Z",

"status": "EXPIRED",

"appDiscountType": {

"appKey": "shopify-web",

"functionId": "13d358d1-2a5b-4a39-a6f9-8f53394e440d"

"combinesWith": {

"orderDiscounts": false,

"productDiscounts": false,

"shippingDiscounts": false

}