Anchor to section titled 'undefined'discount
discount
mutation
Unstable
Requires write access scope.
Updates a code app discount.
Anchor to section titled 'Arguments'
Arguments
The input fields required to update the code app discount.
The ID of the code app discount to update.
Was this section helpful?
Anchor to section titled 'DiscountCodeAppUpdatePayload returns'
DiscountCodeAppUpdatePayload returns
The updated code app discount.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: discountCodeAppUpdate
Query Reference for MUTATION: discountCodeAppUpdate
"mutation discountCodeAppUpdate($codeAppDiscount: DiscountCodeAppInput!, $id: ID!) {\n discountCodeAppUpdate(codeAppDiscount: $codeAppDiscount, id: $id) {\n codeAppDiscount {\n # DiscountCodeApp fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: discountCodeAppUpdate
"{\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 \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: discountCodeAppUpdate
"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: discountCodeAppUpdate
[
{
"example": {
"type_name": "discountcodeappupdate",
"title": "Update an app code discount",
"description": "This endpoint updates an app code discount. This is different from basic code discount mutation\nas this endpoint updates only code function discounts.\n",
"query_string": "mutation discountCodeAppUpdate($codeAppDiscount: DiscountCodeAppInput!, $id: ID!) {\n discountCodeAppUpdate(codeAppDiscount: $codeAppDiscount, id: $id) {\n codeAppDiscount {\n discountId\n title\n endsAt\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/DiscountCodeNode/549381256",
"codeAppDiscount": {
"title": "Take 5$ from order discount",
"endsAt": "2020-08-07T00:00:00Z"
}
},
"response": {
"data": {
"discountCodeAppUpdate": {
"codeAppDiscount": {
"discountId": "gid://shopify/DiscountCodeNode/549381256",
"title": "Take 5$ from order discount",
"endsAt": "2020-08-07T00:00:00Z"
},
"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_update_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 discountCodeAppUpdate($codeAppDiscount: DiscountCodeAppInput!, $id: ID!) { discountCodeAppUpdate(codeAppDiscount: $codeAppDiscount, id: $id) { codeAppDiscount { discountId title endsAt } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DiscountCodeNode/549381256\",\n \"codeAppDiscount\": {\n \"title\": \"Take 5$ from order discount\",\n \"endsAt\": \"2020-08-07T00:00:00Z\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation discountCodeAppUpdate($codeAppDiscount: DiscountCodeAppInput!, $id: ID!) {\n discountCodeAppUpdate(codeAppDiscount: $codeAppDiscount, id: $id) {\n codeAppDiscount {\n discountId\n title\n endsAt\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DiscountCodeNode/549381256\",\n \"codeAppDiscount\": {\n \"title\": \"Take 5$ from order discount\",\n \"endsAt\": \"2020-08-07T00:00:00Z\"\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 discountCodeAppUpdate($codeAppDiscount: DiscountCodeAppInput!, $id: ID!) {\n discountCodeAppUpdate(codeAppDiscount: $codeAppDiscount, id: $id) {\n codeAppDiscount {\n discountId\n title\n endsAt\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DiscountCodeNode/549381256\",\n \"codeAppDiscount\": {\n \"title\": \"Take 5$ from order discount\",\n \"endsAt\": \"2020-08-07T00:00:00Z\"\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 discountCodeAppUpdate($codeAppDiscount: DiscountCodeAppInput!, $id: ID!) {\n discountCodeAppUpdate(codeAppDiscount: $codeAppDiscount, id: $id) {\n codeAppDiscount {\n discountId\n title\n endsAt\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DiscountCodeNode/549381256\",\n \"codeAppDiscount\": {\n \"title\": \"Take 5$ from order discount\",\n \"endsAt\": \"2020-08-07T00:00:00Z\"\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 discountCodeAppUpdate($codeAppDiscount: DiscountCodeAppInput!, $id: ID!) {\n discountCodeAppUpdate(codeAppDiscount: $codeAppDiscount, id: $id) {\n codeAppDiscount {\n discountId\n title\n endsAt\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/DiscountCodeNode/549381256\",\n \"codeAppDiscount\" => [\n \"title\" => \"Take 5$ from order discount\",\n \"endsAt\" => \"2020-08-07T00:00:00Z\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the code app discount to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/DiscountCodeNode/549381256\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "codeAppDiscount",
"description": "The input fields required to update the code 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": " {\"title\":\"Take 5$ from order discount\",\"endsAt\":\"2020-08-07T00:00:00Z\"}",
"typeKind": "MUTATION"
}
]
}
]