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.

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?

Create a non-combinable automatic discount that's managed by an app
Create an automatic product discount that's managed by an app
discountAutomaticAppCreate reference

Examples

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": {

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-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": "de7a6b74-5ac7-432f-8d5b-98dd14fb8af5",
      "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 { 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": "de7a6b74-5ac7-432f-8d5b-98dd14fb8af5",
        "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();

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": "de7a6b74-5ac7-432f-8d5b-98dd14fb8af5",
        "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}"
          }
        ]
      }
    },
  },
});

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": "de7a6b74-5ac7-432f-8d5b-98dd14fb8af5",
    "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)

Input variables

JSON

{

"automaticAppDiscount": {

"title": "$5 discount",

"functionId": "de7a6b74-5ac7-432f-8d5b-98dd14fb8af5",

"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

JSON

{

"discountAutomaticAppCreate": {

"userErrors": [],

"automaticAppDiscount": {

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

"title": "$5 discount",

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

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

"status": "SCHEDULED",

"appDiscountType": {

"appKey": "shopify-web",

"functionId": "f14c0c43-7660-44bf-9c5e-78c2ad0defe7"

"combinesWith": {

"orderDiscounts": false,

"productDiscounts": false,

"shippingDiscounts": false

}