Skip to content

Need custom checkout logic your theme settings cannot handle?

APIs for pickup and delivery on any Shopify storefront

Let your developer read your customer's pickup or delivery choice and hold checkout until it's complete. The same widget also runs on custom-built storefronts, including Hydrogen.

14-day free trial500+ reviews on the Shopify App StoreTrusted by 7,000+ Shopify storesBuilt for Shopify
One global, window.BirdApp: read the selection, check checkout, listen for events.

What changes when you bring in a developer for Bird APIs?

  • Checkout rules match your exact flow

    A developer can gate checkout and handle edge cases, so customers cannot skip required pickup or delivery details.

  • Custom storefronts stay schedule-aware

    If you run headless, your developer can mount Bird and keep selection data synced with your cart experience.

  • Your team can trigger smarter automations

    Events and API data let your developer connect Bird selections to internal workflows and apps you already use.

What are Bird's developer APIs?

Bird Pickup & Delivery, the Shopify app by BirdChime, gives your developer tools for your store. They can read your customer's pickup or delivery choice, track when it changes, check if checkout can go ahead, and control the widget. Bird also runs on custom-built storefronts, and a REST API connects your own server, mobile apps, and other apps.

Quick facts
Custom-built storefrontsUse Hydrogen, React, Vue, or plain HTML with one stylesheet and one script
Developer referenceFind the reference at picdel.birdchime.com/api-docs
PriceFrom $19.99 a month, billed through Shopify, with a 14-day free trial. Compare plans
Used by7,000+ Shopify stores in 60+ countries

Everything you can set

What can the JavaScript API do?

It reads the customer's selection, reacts to changes, checks whether checkout can proceed and controls the widget.

You canWhat happensFor example
Read the selectionsdk.selections.current gives the method, date, time, location, order note, SMS opt-in and resolved delivery address.Example: Your developer reads sdk.selections.current to place the selected pickup time inside a custom cart summary.
Subscribe to changessdk.subscribe() runs your callback straight away and on every change, and returns a function to stop listening.Example: When a customer switches from pickup to delivery, your custom banner updates from the subscription callback.
Check checkoutsdk.selections.canCheckout() returns canProceed and a reason: selection_incomplete, minimum_order_value_not_met, cart_ineligible, schedule_conflict, not_ready, saving or save_failed.Example: On a custom checkout button, call canCheckout() on click. If canProceed is false, stop the click and dispatch bird:checkout:attempted. Gate Shop Pay, PayPal and Apple Pay buttons the same way, since they skip the cart page.
Control the widgetwidget.isMounted(), widget.hide() and widget.remount(), for example after a theme redraws the cart.Example: After a cart drawer refresh, your developer remounts the widget so date selection stays visible.

Which events does the widget fire?

Selection and checkout events on window, and lifecycle events on document.

You canWhat happensFor example
bird:selection:changedAny selection field changes, with the field, value and a compact selection. Fires on Liquid themes and headless.Example: Your analytics tool logs when customers switch delivery method by listening to bird:selection:changed.
bird:selection:completeThe selection becomes complete, with the method, location, date and time.Example: Once a shopper picks method, date, and slot, your custom checkout panel unlocks.
bird:checkout:attemptedCheckout was clicked while incomplete. You can also dispatch it yourself to reveal the errors.Example: A custom Buy now button dispatches bird:checkout:attempted to show missing fields before redirect.
bird:widget:*initialized, reinitialized and removed, for when the widget mounts, re-mounts and unmounts.Example: After an AJAX cart redraw, listen for bird:widget:reinitialized and re-attach anything that stopped working.

Can I use Bird on a headless storefront?

Yes. Add one stylesheet and one script, set your shop domain, and mount the widget.

You canWhat happensFor example
Any frameworkHydrogen, React, Vue or plain HTML. No theme app extension, build step or npm package.Example: On Hydrogen, mount the widget inside a useEffect after render, pass your Storefront cart to sdk.setCart(), and call it again whenever the cart changes.
Your settings come alongThe widget loads your settings, translations, time zone and availability rules from Bird.Example: Your headless storefront still uses the same translated labels and availability rules as your Bird settings.
Cart and product widgetsMount the cart widget, or a product widget with the item's tags and collections so per-product rules apply.Example: A product page widget can show only eligible dates for a cake tagged with a longer lead time.
Only shop is requiredSet window.BirdApp.config with your myshopify.com domain before the bundle loads. If setup fails, ready resolves to null instead of throwing.Example: With only the shop domain configured, your developer can still initialize Bird and handle null-ready fallback safely.
You gate checkoutHeadless bundles don't patch your checkout button, so check canCheckout() before letting customers through.Example: Before opening checkout, your developer blocks the action until canCheckout() returns canProceed true.

What can I change on a regular Shopify theme?

Developer settings in Bird take custom JavaScript and CSS, and fix placement for unusual themes.

You canWhat happensFor example
Advanced scriptingRun your own JavaScript on the cart page, for example to fill the postal code from another app.Example: Your store can prefill delivery postal code from a loyalty widget to cut typing at checkout.
Advanced stylingOverride the widget's styles with your own CSS.Example: A developer matches widget fonts and spacing to your brand style guide in one stylesheet.
Placement and checkout buttonAnchor the widget to any element with a CSS selector, and point Bird at your theme's checkout button if it isn't detected.Example: On a custom cart layout, Bird is anchored below order totals and tied to your custom checkout button.
Load only on the cart pageRestrict the widget to the cart page. Leave it off if your store uses a cart drawer.Example: A store with a drawer cart keeps Bird off drawer views and loads it only on the full cart page.

Is there a REST API?

Yes, for server-side and third-party integrations such as mobile apps and other Shopify apps.

You canWhat happensFor example
On the orderEach order carries the customer's choice as attributes: Delivery Method, Delivery Date and Delivery Time.Example: Your ERP import can read Delivery Date from order attributes without scraping storefront pages.
Legacy widgetStores still on the legacy widget use the older BirdSDK global and birdchime:* events. The current widget uses window.BirdApp and bird:* events.Example: If your developer maintains older theme code, they can keep legacy events working during migration.
Order automationFor no-code automation on orders, Bird also has Shopify Flow triggers and actions.Example: Your team can trigger a packing checklist when Bird marks a delivery order dispatched.

Liquid theme or headless storefront: what changes?

CapabilityLiquid themeHeadless storefront
MountingLiquid themeThe widget mounts itselfHeadless storefrontYou call widget.mount()
CartLiquid themeRead from the themeHeadless storefrontYou pass it with sdk.setCart()
Checkout buttonLiquid themeBird patches itHeadless storefrontYou gate it with canCheckout()
EventsLiquid themeAll bird:* eventsHeadless storefrontOnly bird:selection:changed

Where do I start?

On a Liquid theme, await window.BirdApp.ready and call the SDK. On headless, add the stylesheet and script, set your shop domain and mount the widget. The guides have every method and event.

FAQ

What else do developers ask?

How can I read the customer's pickup or delivery date in my own code?

Await window.BirdApp.ready to get the SDK, then read sdk.selections.current for the method, date (YYYY-MM-DD), time, location and more. Use sdk.subscribe() to react to changes.

Does Bird work with Hydrogen?

Yes. Mount the widget in the browser only, inside a useEffect, and keep it fed with sdk.setCart().

How do I stop customers checking out without a date on a custom button?

Call sdk.selections.canCheckout(). If canProceed is false, block the click and dispatch bird:checkout:attempted so the widget shows which fields are missing.

Which events fire on a headless storefront?

Only bird:selection:changed. Use sdk.subscribe() for state changes and canCheckout() to know when checkout can proceed.

Is there a REST API for mobile apps?

Yes. The REST API is for server-side and third-party integrations, such as mobile apps and other Shopify apps. Its reference is at picdel.birdchime.com/api-docs.

Does it work for Shopify stores outside the US?

The headless widget takes a locale in its config and loads your translations and time zone from Bird.

Do I need a developer?

Usually not. Most stores never need these settings: on a standard Shopify theme the widget mounts itself. Custom checkout buttons, headless builds and scripts need someone comfortable with JavaScript.

How much do Bird's developer APIs cost?

You can start from $19.99 a month on paid plans, billed through Shopify, with a 14-day free trial and 10% off annual billing. The pricing page shows what each plan includes.

Terms on this page
window.BirdApp
The single global holding Bird's config, ready promise, SDK and widget controls.
canCheckout()
Returns whether checkout can proceed, and the reason if not.
setCart()
Passes your Storefront API cart to the widget on headless storefronts.
bird:checkout:attempted
The one event you can dispatch, to reveal the widget's field errors.

Build it your way.

Try Bird free for 14 days on any paid plan. Your developer can read a real pickup or delivery choice from your store before you pay.