# discountCodeAppCreate - admin-graphql - MUTATION Version: 2024-10 ## Description Creates a code discount. The discount type must be provided by an app extension that uses [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Functions can implement [order](https://shopify.dev/docs/api/functions/reference/order-discounts), [product](https://shopify.dev/docs/api/functions/reference/product-discounts), or [shipping](https://shopify.dev/docs/api/functions/reference/shipping-discounts) discount functions. Use this mutation with Shopify Functions when you need custom logic beyond [Shopify's native discount types](https://help.shopify.com/manual/discounts/discount-types). For example, use this mutation to create a code 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](https://shopify.dev/docs/apps/build/discounts/build-discount-function). > Note: > To create automatic discounts with custom logic, use [`discountAutomaticAppCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountAutomaticAppCreate). ### Access Scopes `write_discounts` access scope. ## Arguments * [codeAppDiscount](/docs/api/admin-graphql/2024-10/input-objects/DiscountCodeAppInput): DiscountCodeAppInput! - The input data used to create the discount. ## Returns * [codeAppDiscount](/docs/api/admin-graphql/2024-10/objects/DiscountCodeApp): DiscountCodeApp The discount that the app provides. * [userErrors](/docs/api/admin-graphql/2024-10/objects/DiscountUserError): DiscountUserError! The list of errors that occurred from executing the mutation. ## Examples ### Create a combinable code discount that's managed by an app 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 discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) { discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) { codeAppDiscount { discountId title appDiscountType { description functionId } combinesWith { orderDiscounts productDiscounts shippingDiscounts } codes(first: 100) { nodes { code } } status usageLimit } userErrors { field message } } }\",\n \"variables\": {\n \"codeAppDiscount\": {\n \"code\": \"APP_DISCOUNT\",\n \"title\": \"Take 5$ from order discount\",\n \"functionId\": \"241d1090-ce51-4c0e-8b87-a6fa14fe580a\",\n \"appliesOncePerCustomer\": true,\n \"combinesWith\": {\n \"orderDiscounts\": true,\n \"productDiscounts\": true,\n \"shippingDiscounts\": true\n },\n \"startsAt\": \"2021-02-02T17:09:21Z\",\n \"endsAt\": \"2022-02-02T17:09:21Z\",\n \"usageLimit\": 1,\n \"metafields\": [\n {\n \"namespace\": \"default\",\n \"key\": \"function-configuration\",\n \"type\": \"json\",\n \"value\": \"{\\\"discounts\\\":[{\\\"value\\\":{\\\"fixedAmount\\\":{\\\"amount\\\":5}},\\\"targets\\\":\\n [{\\\"orderSubtotal\\\":{\\\"excludedVariantIds\\\":[]}}]}],\\\"discountApplicationStrategy\\\":\\\"FIRST\\\"}\"\n }\n ]\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) {\n discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) {\n codeAppDiscount {\n discountId\n title\n appDiscountType {\n description\n functionId\n }\n combinesWith {\n orderDiscounts\n productDiscounts\n shippingDiscounts\n }\n codes(first: 100) {\n nodes {\n code\n }\n }\n status\n usageLimit\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"codeAppDiscount\": {\n \"code\": \"APP_DISCOUNT\",\n \"title\": \"Take 5$ from order discount\",\n \"functionId\": \"241d1090-ce51-4c0e-8b87-a6fa14fe580a\",\n \"appliesOncePerCustomer\": true,\n \"combinesWith\": {\n \"orderDiscounts\": true,\n \"productDiscounts\": true,\n \"shippingDiscounts\": true\n },\n \"startsAt\": \"2021-02-02T17:09:21Z\",\n \"endsAt\": \"2022-02-02T17:09:21Z\",\n \"usageLimit\": 1,\n \"metafields\": [\n {\n \"namespace\": \"default\",\n \"key\": \"function-configuration\",\n \"type\": \"json\",\n \"value\": \"{\\\"discounts\\\":[{\\\"value\\\":{\\\"fixedAmount\\\":{\\\"amount\\\":5}},\\\"targets\\\":\\n [{\\\"orderSubtotal\\\":{\\\"excludedVariantIds\\\":[]}}]}],\\\"discountApplicationStrategy\\\":\\\"FIRST\\\"}\"\n }\n ]\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 discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) {\n discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) {\n codeAppDiscount {\n discountId\n title\n appDiscountType {\n description\n functionId\n }\n combinesWith {\n orderDiscounts\n productDiscounts\n shippingDiscounts\n }\n codes(first: 100) {\n nodes {\n code\n }\n }\n status\n usageLimit\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"codeAppDiscount\": {\n \"code\": \"APP_DISCOUNT\",\n \"title\": \"Take 5$ from order discount\",\n \"functionId\": \"241d1090-ce51-4c0e-8b87-a6fa14fe580a\",\n \"appliesOncePerCustomer\": true,\n \"combinesWith\": {\n \"orderDiscounts\": true,\n \"productDiscounts\": true,\n \"shippingDiscounts\": true\n },\n \"startsAt\": \"2021-02-02T17:09:21Z\",\n \"endsAt\": \"2022-02-02T17:09:21Z\",\n \"usageLimit\": 1,\n \"metafields\": [{\"namespace\"=>\"default\", \"key\"=>\"function-configuration\", \"type\"=>\"json\", \"value\"=>\"{\\\"discounts\\\":[{\\\"value\\\":{\\\"fixedAmount\\\":{\\\"amount\\\":5}},\\\"targets\\\":\\n [{\\\"orderSubtotal\\\":{\\\"excludedVariantIds\\\":[]}}]}],\\\"discountApplicationStrategy\\\":\\\"FIRST\\\"}\"}]\n }\n}\n\nresponse = 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 discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) {\n discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) {\n codeAppDiscount {\n discountId\n title\n appDiscountType {\n description\n functionId\n }\n combinesWith {\n orderDiscounts\n productDiscounts\n shippingDiscounts\n }\n codes(first: 100) {\n nodes {\n code\n }\n }\n status\n usageLimit\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"codeAppDiscount\": {\n \"code\": \"APP_DISCOUNT\",\n \"title\": \"Take 5$ from order discount\",\n \"functionId\": \"241d1090-ce51-4c0e-8b87-a6fa14fe580a\",\n \"appliesOncePerCustomer\": true,\n \"combinesWith\": {\n \"orderDiscounts\": true,\n \"productDiscounts\": true,\n \"shippingDiscounts\": true\n },\n \"startsAt\": \"2021-02-02T17:09:21Z\",\n \"endsAt\": \"2022-02-02T17:09:21Z\",\n \"usageLimit\": 1,\n \"metafields\": [\n {\n \"namespace\": \"default\",\n \"key\": \"function-configuration\",\n \"type\": \"json\",\n \"value\": \"{\\\"discounts\\\":[{\\\"value\\\":{\\\"fixedAmount\\\":{\\\"amount\\\":5}},\\\"targets\\\":\\n [{\\\"orderSubtotal\\\":{\\\"excludedVariantIds\\\":[]}}]}],\\\"discountApplicationStrategy\\\":\\\"FIRST\\\"}\"\n }\n ]\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) {\n discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) {\n codeAppDiscount {\n discountId\n title\n appDiscountType {\n description\n functionId\n }\n combinesWith {\n orderDiscounts\n productDiscounts\n shippingDiscounts\n }\n codes(first: 100) {\n nodes {\n code\n }\n }\n status\n usageLimit\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "codeAppDiscount": { "code": "APP_DISCOUNT", "title": "Take 5$ from order discount", "functionId": "241d1090-ce51-4c0e-8b87-a6fa14fe580a", "appliesOncePerCustomer": true, "combinesWith": { "orderDiscounts": true, "productDiscounts": true, "shippingDiscounts": true }, "startsAt": "2021-02-02T17:09:21Z", "endsAt": "2022-02-02T17:09:21Z", "usageLimit": 1, "metafields": [ { "namespace": "default", "key": "function-configuration", "type": "json", "value": "{\"discounts\":[{\"value\":{\"fixedAmount\":{\"amount\":5}},\"targets\":\n [{\"orderSubtotal\":{\"excludedVariantIds\":[]}}]}],\"discountApplicationStrategy\":\"FIRST\"}" } ] } } #### Graphql Response { "data": { "discountCodeAppCreate": { "codeAppDiscount": { "discountId": "gid://shopify/DiscountCodeNode/1057371199", "title": "Take 5$ from order discount", "appDiscountType": { "description": "my function does a thing", "functionId": "af8aad4b-5db2-4eb8-8a22-1d5d11657d17" }, "combinesWith": { "orderDiscounts": true, "productDiscounts": true, "shippingDiscounts": true }, "codes": { "nodes": [ { "code": "APP_DISCOUNT" } ] }, "status": "EXPIRED", "usageLimit": 1 }, "userErrors": [] } } } ### Create a product-based code discount that's managed by an app 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 discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) { discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) { codeAppDiscount { discountId title appDiscountType { description functionId } combinesWith { orderDiscounts productDiscounts shippingDiscounts } codes(first: 5) { nodes { code } } status usageLimit } userErrors { field message } } }\",\n \"variables\": {\n \"codeAppDiscount\": {\n \"code\": \"PRODUCT10\",\n \"title\": \"10% off selected products\",\n \"functionId\": \"6ca45d1e-e776-4e86-8404-ad521b258b60\",\n \"appliesOncePerCustomer\": false,\n \"combinesWith\": {\n \"orderDiscounts\": false,\n \"productDiscounts\": false,\n \"shippingDiscounts\": true\n },\n \"startsAt\": \"2025-01-01T00:00:00Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"metafields\": [\n {\n \"namespace\": \"default\",\n \"key\": \"function-configuration\",\n \"type\": \"json\",\n \"value\": \"{\\\"discounts\\\":[{\\\"value\\\":{\\\"percentage\\\":0.10},\\\"targets\\\":[{\\\"productVariants\\\":\\n {\\\"productsToDiscount\\\":[\\\"gid://shopify/Product/123\\\"],\\\"excludedVariantIds\\\":[]}}]}],\\n \\\"discountApplicationStrategy\\\":\\\"FIRST\\\"}\"\n }\n ]\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) {\n discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) {\n codeAppDiscount {\n discountId\n title\n appDiscountType {\n description\n functionId\n }\n combinesWith {\n orderDiscounts\n productDiscounts\n shippingDiscounts\n }\n codes(first: 5) {\n nodes {\n code\n }\n }\n status\n usageLimit\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"codeAppDiscount\": {\n \"code\": \"PRODUCT10\",\n \"title\": \"10% off selected products\",\n \"functionId\": \"6ca45d1e-e776-4e86-8404-ad521b258b60\",\n \"appliesOncePerCustomer\": false,\n \"combinesWith\": {\n \"orderDiscounts\": false,\n \"productDiscounts\": false,\n \"shippingDiscounts\": true\n },\n \"startsAt\": \"2025-01-01T00:00:00Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"metafields\": [\n {\n \"namespace\": \"default\",\n \"key\": \"function-configuration\",\n \"type\": \"json\",\n \"value\": \"{\\\"discounts\\\":[{\\\"value\\\":{\\\"percentage\\\":0.10},\\\"targets\\\":[{\\\"productVariants\\\":\\n {\\\"productsToDiscount\\\":[\\\"gid://shopify/Product/123\\\"],\\\"excludedVariantIds\\\":[]}}]}],\\n \\\"discountApplicationStrategy\\\":\\\"FIRST\\\"}\"\n }\n ]\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 discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) {\n discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) {\n codeAppDiscount {\n discountId\n title\n appDiscountType {\n description\n functionId\n }\n combinesWith {\n orderDiscounts\n productDiscounts\n shippingDiscounts\n }\n codes(first: 5) {\n nodes {\n code\n }\n }\n status\n usageLimit\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"codeAppDiscount\": {\n \"code\": \"PRODUCT10\",\n \"title\": \"10% off selected products\",\n \"functionId\": \"6ca45d1e-e776-4e86-8404-ad521b258b60\",\n \"appliesOncePerCustomer\": false,\n \"combinesWith\": {\n \"orderDiscounts\": false,\n \"productDiscounts\": false,\n \"shippingDiscounts\": true\n },\n \"startsAt\": \"2025-01-01T00:00:00Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"metafields\": [{\"namespace\"=>\"default\", \"key\"=>\"function-configuration\", \"type\"=>\"json\", \"value\"=>\"{\\\"discounts\\\":[{\\\"value\\\":{\\\"percentage\\\":0.10},\\\"targets\\\":[{\\\"productVariants\\\":\\n {\\\"productsToDiscount\\\":[\\\"gid://shopify/Product/123\\\"],\\\"excludedVariantIds\\\":[]}}]}],\\n \\\"discountApplicationStrategy\\\":\\\"FIRST\\\"}\"}]\n }\n}\n\nresponse = 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 discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) {\n discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) {\n codeAppDiscount {\n discountId\n title\n appDiscountType {\n description\n functionId\n }\n combinesWith {\n orderDiscounts\n productDiscounts\n shippingDiscounts\n }\n codes(first: 5) {\n nodes {\n code\n }\n }\n status\n usageLimit\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"codeAppDiscount\": {\n \"code\": \"PRODUCT10\",\n \"title\": \"10% off selected products\",\n \"functionId\": \"6ca45d1e-e776-4e86-8404-ad521b258b60\",\n \"appliesOncePerCustomer\": false,\n \"combinesWith\": {\n \"orderDiscounts\": false,\n \"productDiscounts\": false,\n \"shippingDiscounts\": true\n },\n \"startsAt\": \"2025-01-01T00:00:00Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"metafields\": [\n {\n \"namespace\": \"default\",\n \"key\": \"function-configuration\",\n \"type\": \"json\",\n \"value\": \"{\\\"discounts\\\":[{\\\"value\\\":{\\\"percentage\\\":0.10},\\\"targets\\\":[{\\\"productVariants\\\":\\n {\\\"productsToDiscount\\\":[\\\"gid://shopify/Product/123\\\"],\\\"excludedVariantIds\\\":[]}}]}],\\n \\\"discountApplicationStrategy\\\":\\\"FIRST\\\"}\"\n }\n ]\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) {\n discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) {\n codeAppDiscount {\n discountId\n title\n appDiscountType {\n description\n functionId\n }\n combinesWith {\n orderDiscounts\n productDiscounts\n shippingDiscounts\n }\n codes(first: 5) {\n nodes {\n code\n }\n }\n status\n usageLimit\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "codeAppDiscount": { "code": "PRODUCT10", "title": "10% off selected products", "functionId": "6ca45d1e-e776-4e86-8404-ad521b258b60", "appliesOncePerCustomer": false, "combinesWith": { "orderDiscounts": false, "productDiscounts": false, "shippingDiscounts": true }, "startsAt": "2025-01-01T00:00:00Z", "endsAt": "2025-12-31T23:59:59Z", "metafields": [ { "namespace": "default", "key": "function-configuration", "type": "json", "value": "{\"discounts\":[{\"value\":{\"percentage\":0.10},\"targets\":[{\"productVariants\":\n {\"productsToDiscount\":[\"gid://shopify/Product/123\"],\"excludedVariantIds\":[]}}]}],\n \"discountApplicationStrategy\":\"FIRST\"}" } ] } } #### Graphql Response { "data": { "discountCodeAppCreate": { "codeAppDiscount": { "discountId": "gid://shopify/DiscountCodeNode/1057371198", "title": "10% off selected products", "appDiscountType": { "description": "my function does a thing", "functionId": "6ca45d1e-e776-4e86-8404-ad521b258b60" }, "combinesWith": { "orderDiscounts": false, "productDiscounts": false, "shippingDiscounts": true }, "codes": { "nodes": [ { "code": "PRODUCT10" } ] }, "status": "ACTIVE", "usageLimit": null }, "userErrors": [] } } }