Skip to main content
Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.

Pickup points

When buyers choose pickup point delivery, checkout displays a location search form and a list of nearby collection points, such as parcel lockers and carrier service points. Use these targets to add content before and after that UI.

  • Location guidance: Display a message above the location search form, such as coverage areas or tips for finding the nearest pickup point.
  • Carrier information: Display carrier names, collection hours, or network details for available pickup points.
  • Collection instructions: Show what buyers need when collecting their package, such as a photo ID or order confirmation number.
  • Pickup promotion: Reinforce the buyer's choice with a discount or reward when they select pickup point delivery.

Anchor to Pickup points targetsPickup points targets

Use these targets to add content around the pickup point selection UI. Buyers move through two views: a location search form and a results list. The extension receives isLocationFormVisible to distinguish between them. For UX guidance, see UX for pickup points.

purchase.checkout.pickup-point-list.render-before

Renders before the pickup point UI, covering both the location search form and the results list. Use api.isLocationFormVisible.current to determine which view the buyer is in and adapt your content. Pickup point details, including carrier names, location addresses, and costs, are accessible through deliveryGroups.

Support
Components (59)
APIs (25)

purchase.checkout.pickup-point-list.render-after

Renders after the pickup point list. Use this target for content that's relevant after the buyer views or selects a pickup point, such as collection reminders or package handling instructions.

Support
Components (59)
APIs (25)

  • Adapt content to the current view: The buyer moves through two distinct views when selecting a pickup point: the location search form and the results list. Use api.isLocationFormVisible.current to show content relevant to each view.
  • Keep location guidance brief: Buyers entering their location are completing a focused task. Content in render-before during the location search step sits above the form and pushes it down. Keep any guidance concise and directly relevant to the search.

  • Limited PickupPointListApi: PickupPointListApi provides only isLocationFormVisible. Carrier names, location addresses, and costs are accessible through deliveryGroups, but collection hours and service area details aren't. The buyer's search address isn't exposed.
  • isLocationFormVisible is load-time only: isLocationFormVisible reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place.
  • Read-only selection: The available write operations (cart notes, metafields, discount codes) don't include setting or changing the pickup point selection or modifying the search address.

Was this page helpful?