priceRuleDiscountCodeUpdate

mutation

deprecated

Code examples for MUTATION: priceRuleDiscountCodeUpdate

Query Reference for MUTATION: priceRuleDiscountCodeUpdate

"mutation priceRuleDiscountCodeUpdate($code: String!, $priceRuleId: ID!) {\n  priceRuleDiscountCodeUpdate(code: $code, priceRuleId: $priceRuleId) {\n    priceRule {\n      # PriceRule fields\n    }\n    priceRuleDiscountCode {\n      # PriceRuleDiscountCode fields\n    }\n    priceRuleUserErrors {\n      # PriceRuleUserError fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: priceRuleDiscountCodeUpdate

"{\n  \"code\": \"<your-code>\",\n  \"priceRuleId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: priceRuleDiscountCodeUpdate

""

Display Examples for MUTATION: priceRuleDiscountCodeUpdate

[
  {
    "example": {
      "type_name": "pricerulediscountcodeupdate",
      "title": "Update a discount code for a price rule",
      "query_string": "mutation priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {\n  priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {\n    priceRuleUserErrors {\n      field\n      message\n      code\n    }\n    priceRule {\n      id\n      title\n      allocationMethod\n      target\n      validityPeriod {\n        start\n        end\n      }\n    }\n    priceRuleDiscountCode {\n      code\n    }\n  }\n}",
      "variables": {
        "priceRuleId": "gid://shopify/PriceRule/1057371214",
        "code": "NEWCODE"
      },
      "response": {
        "data": {
          "priceRuleDiscountCodeUpdate": {
            "priceRuleUserErrors": [],
            "priceRule": {
              "id": "gid://shopify/PriceRule/1057371214",
              "title": "PROTABO",
              "allocationMethod": "ACROSS",
              "target": "LINE_ITEM",
              "validityPeriod": {
                "start": "2016-08-29T16:00:00Z",
                "end": "2124-09-12T02:11:13Z"
              }
            },
            "priceRuleDiscountCode": {
              "code": "NEWCODE"
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "2024-07",
      "location": "/components/pricing/test/unit/graph_api/admin/mutations/price_rule_discount_code_update_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) { priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) { priceRuleUserErrors { field message code } priceRule { id title allocationMethod target validityPeriod { start end } } priceRuleDiscountCode { code } } }\",\n \"variables\": {\n    \"priceRuleId\": \"gid://shopify/PriceRule/1057371214\",\n    \"code\": \"NEWCODE\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {\n    priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {\n      priceRuleUserErrors {\n        field\n        message\n        code\n      }\n      priceRule {\n        id\n        title\n        allocationMethod\n        target\n        validityPeriod {\n          start\n          end\n        }\n      }\n      priceRuleDiscountCode {\n        code\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"priceRuleId\": \"gid://shopify/PriceRule/1057371214\",\n      \"code\": \"NEWCODE\"\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 priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {\n    priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {\n      priceRuleUserErrors {\n        field\n        message\n        code\n      }\n      priceRule {\n        id\n        title\n        allocationMethod\n        target\n        validityPeriod {\n          start\n          end\n        }\n      }\n      priceRuleDiscountCode {\n        code\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"priceRuleId\": \"gid://shopify/PriceRule/1057371214\",\n  \"code\": \"NEWCODE\"\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 priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {\n      priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {\n        priceRuleUserErrors {\n          field\n          message\n          code\n        }\n        priceRule {\n          id\n          title\n          allocationMethod\n          target\n          validityPeriod {\n            start\n            end\n          }\n        }\n        priceRuleDiscountCode {\n          code\n        }\n      }\n    }`,\n    \"variables\": {\n      \"priceRuleId\": \"gid://shopify/PriceRule/1057371214\",\n      \"code\": \"NEWCODE\"\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 priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {\n    priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {\n      priceRuleUserErrors {\n        field\n        message\n        code\n      }\n      priceRule {\n        id\n        title\n        allocationMethod\n        target\n        validityPeriod {\n          start\n          end\n        }\n      }\n      priceRuleDiscountCode {\n        code\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"priceRuleId\" => \"gid://shopify/PriceRule/1057371214\",\n  \"code\" => \"NEWCODE\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "priceRuleId",
          "description": "The ID of the price rule object.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "priceRuleId",
        "argValue": " \"gid://shopify/PriceRule/1057371214\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "code",
          "description": "The new code of a price rule.",
          "type": {
            "kind": "SCALAR",
            "name": "String",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "String!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "code",
        "argValue": " \"NEWCODE\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]