Switchboard docs

Docs. Quickstart, SDK, per-rule limits.

Enough to install Switchboard, ship your first rule from the admin, and know exactly what the developer-mode surface can and can't do before you wire it.

Quickstart

Ship your first rule.

1. Install Switchboard from the Shopify App Store. Approve the standard permissions. Nothing runs until you turn a rule on.
2. Pick a Function family. From the Switchboard dashboard, choose the family that matches the problem you're solving: validation, discount, payment, fulfillment, bundle, delivery, shipping, trust badges, or a signed-price cart transform.
3. Configure the rule. Each rule is a form. Fill in the fields, write the customer-facing message when there is one, and save.
4. Activate on a preview theme. Activate the rule against a preview theme first. Run through the checkout once, confirm the behaviour, then promote to your live theme.
5. Watch the first live orders. A rule that reshapes checkout should be watched for the first day of real orders. Every rule can be toggled off without a redeploy.

SDK reference

The storefront SDK.

Developer-mode rules read a small JSON payload from a global your storefront sets before checkout begins. Switchboard signs the payload, verifies it inside the Function, and applies the rule. The same shape covers every developer-mode family: block, discount, payment hide, fulfillment steer, bundle trigger, signed-price line.

window.Switchboard = {
  rule: "block-checkout",
  reason: "inventory-race",
  message: "This item just sold out. Please refresh your cart.",
};

Set the object as early as possible, before the customer clicks checkout. The Function reads it once per checkout, verifies the signature, and applies the rule. If the payload is missing or the signature fails, the rule is skipped and checkout proceeds normally.

Per-rule limits

What each family can and can't do.

Validation: Runs on every Shopify plan. Sees the cart, the shipping address, and the customer, and can refuse the checkout with a message. Can't see payment details.
Discounts: Runs on every plan. Applies per-line or per-order discounts. Code-driven discounts are clamped to caps you set in the admin so a bad payload can't zero an order.
Payment customization: Hides, reorders, or renames methods. Card hiding requires Shopify Plus in the US and Canada; the rule is available on every plan for the methods Shopify allows.
Fulfillment constraints: Runs on every plan. Chooses which location fulfills a line, keeps chosen locations out of the online pool, or prevents an order from being split.
Cart transform: bundles: Runs on every plan. Sells one product and ships its real components, each tracking its own stock.
Cart transform: signed price: Requires Shopify Plus. Sets a line's price from a signed payload; unsigned or invalid payloads are ignored.
Delivery customization: Runs on every plan. Reorders, renames, or filters pickup locations.
Shipping methods: Runs on every plan. Renames, reorders, or hides rates carriers return.
Trust badges: Requires Shopify Plus (checkout extensions). Renders a badge row in the order summary at the payment step.

Install from the App Store Back to the developer tour