Checkout Page

update_order_bump

Destructive

Change how an order bump is offered on one checkout page or event: enabled, preselected, hidden, the show/hide rule, quantity and description clamping. Only supplied fields change. Edit the product's copy and price with update_product. Mutating.

Input Schema

Name	Required	Description
`hidden`	No	Hide the order bump unless the page URL reveals it with `?show_order_bumps=` and the product price reference.
`pageId`	Yes	The ID of the checkout page or event. Use the type you fetched it with (get_checkout_page or get_event).
`enabled`	No	Whether the order bump is offered. A disabled order bump stays on the page but is not shown.
`pageType`	Yes	The kind of page the order bump is on: `checkout` for a checkout page, `event` for an event (where order bumps are shown as add-ons).
`productId`	Yes	The ID of the order bump product placed on the page. Listed as `productId` by list_order_bumps.
`preselected`	No	Whether the order bump is ticked when the page loads.
`allowQuantity`	No	Let the customer pick a quantity. Off, the order bump is bought once.
`showHideLogic`	No	Rule that shows the order bump only for some selections. Sent whole: it replaces the stored rule.
`shortenDescription`	No	Clamp a long description behind a Show more toggle.

Output Schema

Name	Required	Description	Default
`data`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed5 schema fields changedOct 30, 2026

removedInput schema / properties / showHideLogic / properties / priceId

Removed value: -{
-  "anyOf": [
-    {
-      "pattern": "^[0-9a-fA-F]{24}$",
-      "type": "string"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "description": "For `subject: price`: the page product price ID to watch (from get_product). A rule without one is stored but never hides anything."
-}

addedInput schema / properties / showHideLogic / properties / priceIds

Added value: +{
+  "description": "For `subject: price`: the page product price IDs to watch (from get_product). The rule matches while the chosen price is any of them, or none of them for `is_not`. A rule without any is stored but never hides anything.",
+  "items": {
+    "pattern": "^[0-9a-fA-F]{24}$",
+    "type": "string"
+  },
+  "type": "array"
+}

removedOutput schema / $defs / OrderBump / properties / showHideLogic / properties / priceId
```
Removed value: -{
-  "type": [
-    "string",
-    "null"
-  ]
-}
```
addedOutput schema / $defs / OrderBump / properties / showHideLogic / properties / priceIds
```
Added value: +{
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}
```

changedOutput schema / $defs / OrderBump / properties / showHideLogic / required

Previous value: -[
-  "enabled",
-  "subject",
-  "comparison",
-  "priceId",
-  "ticketTypeIds",
-  "orderBumpProductIds"
-]New value: +[
+  "enabled",
+  "subject",
+  "comparison",
+  "priceIds",
+  "ticketTypeIds",
+  "orderBumpProductIds"
+]

AddedOct 19, 2026

TDQS

A4.5/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false and destructiveHint=true, and the description adds the partial-update contract ('Only supplied fields change') plus a reinforcing 'Mutating.' That patch semantics is exactly the extra behavioral context the annotation cannot express. It stops short of stating permissions, reversibility, or whether a cleared rule can be restored, which is why it is not a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences with zero filler: what changes, the partial-update guarantee, the alternative tool, and a mutability flag. The scope statement is front-loaded and every sentence carries a distinct decision-relevant fact.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter, nested, destructive mutation with an output schema already present, the description supplies the pieces the structure does not: patch semantics, the product-editing alternative, and a mutation warning. Nothing an agent needs in order to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the nested showHideLogic object is exhaustively documented in-schema, so the baseline is 3. The description still earns a bump by stating 'Only supplied fields change', which tells the agent that omitted booleans and rules are left untouched rather than reset — a semantic the schema alone does not convey.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

A specific verb plus resource plus scope: 'Change how an order bump is offered on one checkout page or event', then enumerated facets (enabled, preselected, hidden, show/hide rule, quantity, description clamping). It also distinguishes itself from the closely related sibling by naming update_product for copy and price edits, so the agent can tell the two apart without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives an explicit routing rule for the most confusable case: 'Edit the product's copy and price with update_product.' That is real when-to-use-for-what guidance. It does not cover the create/delete/reorder order-bump siblings, but the operation-vs-configuration split is clear from the verb 'change'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Checkout Page tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?