Anchor to section titled 'undefined'discount
discount
mutation
Unstable
Requires write access scope.
Creates a code app discount.
Anchor to section titled 'Arguments'
Arguments
The input data used to create the app discount.
Was this section helpful?
Anchor to section titled 'DiscountCodeAppCreatePayload returns'
DiscountCodeAppCreatePayload returns
The created code app discount.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: discountCodeAppCreate
Query Reference for MUTATION: discountCodeAppCreate
"mutation discountCodeAppCreate($codeAppDiscount: DiscountCodeAppInput!) {\n discountCodeAppCreate(codeAppDiscount: $codeAppDiscount) {\n codeAppDiscount {\n # DiscountCodeApp fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: discountCodeAppCreate
"{\n \"codeAppDiscount\": {\n \"appliesOncePerCustomer\": true,\n \"code\": \"<your-code>\",\n \"combinesWith\": {\n \"orderDiscounts\": true,\n \"productDiscounts\": true,\n \"shippingDiscounts\": true\n },\n \"customerSelection\": {\n \"all\": true,\n \"customerSegments\": {\n \"add\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"remove\": [\n \"gid://shopify/<objectName>/10079785100\"\n ]\n },\n \"customers\": {\n \"add\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"remove\": [\n \"gid://shopify/<objectName>/10079785100\"\n ]\n }\n },\n \"endsAt\": \"2019-09-07T15:50:00Z\",\n \"functionId\": \"<your-functionId>\",\n \"metafields\": [\n {\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\",\n \"type\": \"<your-type>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"startsAt\": \"2019-09-07T15:50:00Z\",\n \"title\": \"<your-title>\",\n \"usageLimit\": 1\n }\n}"Schema Reference for MUTATION: discountCodeAppCreate
"input DiscountCodeAppInput {\n appliesOncePerCustomer: Boolean\n code: String\n combinesWith: DiscountCombinesWithInput\n customerSelection: DiscountCustomerSelectionInput\n endsAt: DateTime\n functionId: String\n metafields: [MetafieldInput!]\n startsAt: DateTime\n title: String\n usageLimit: Int\n}\n\ninput DiscountCombinesWithInput {\n orderDiscounts: Boolean\n productDiscounts: Boolean\n shippingDiscounts: Boolean\n}\n\ninput DiscountCustomerSelectionInput {\n all: Boolean\n customerSegments: DiscountCustomerSegmentsInput\n customers: DiscountCustomersInput\n}\n\ninput MetafieldInput {\n description: String\n id: ID\n key: String\n namespace: String\n type: String\n value: String\n}\n"Display Examples for MUTATION: discountCodeAppCreate
[
{
"example": {
"type_name": "discountcodeappcreate",
"title": "Create an app code discount",
"description": "This endpoint creates an app code discount. This is different from basic code discount creation\nas this endpoint creates a discount with the function id as input and\nthe function id is used to find the function to run.\n",
"query_string": "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}",
"variables": {
"codeAppDiscount": {
"code": "APP_DISCOUNT",
"title": "Take 5$ from order discount",
"functionId": "b42a026e-f96f-4423-938b-54ade7a21161",
"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\"}"
}
]
}
},
"response": {
"data": {
"discountCodeAppCreate": {
"codeAppDiscount": {
"discountId": "gid://shopify/DiscountCodeNode/1057371204",
"title": "Take 5$ from order discount",
"appDiscountType": {
"description": "my function does a thing",
"functionId": "9dfed7ac-5b56-4696-920a-796985c30509"
},
"combinesWith": {
"orderDiscounts": true,
"productDiscounts": true,
"shippingDiscounts": true
},
"codes": {
"nodes": [
{
"code": "APP_DISCOUNT"
}
]
},
"status": "EXPIRED",
"usageLimit": 1
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/pricing/test/unit/graph_api/admin/mutations/discount_code_app_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/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\": \"b42a026e-f96f-4423-938b-54ade7a21161\",\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",
"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\": \"b42a026e-f96f-4423-938b-54ade7a21161\",\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",
"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\": \"b42a026e-f96f-4423-938b-54ade7a21161\",\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",
"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\": \"b42a026e-f96f-4423-938b-54ade7a21161\",\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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\n$variables = [\n \"codeAppDiscount\" => [\n \"code\" => \"APP_DISCOUNT\",\n \"title\" => \"Take 5$ from order discount\",\n \"functionId\" => \"b42a026e-f96f-4423-938b-54ade7a21161\",\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\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "codeAppDiscount",
"description": "The input data used to create the app discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCodeAppInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "DiscountCodeAppInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "codeAppDiscount",
"argValue": " {\"code\":\"APP_DISCOUNT\",\"title\":\"Take 5$ from order discount\",\"functionId\":\"b42a026e-f96f-4423-938b-54ade7a21161\",\"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\\\"}\"}]}",
"typeKind": "MUTATION"
}
]
}
]