Skip to main content

Post-return

Beta

Post-return targets are part of the POS UI extensions feature preview. This feature preview is available on an invite-only basis and requires POS UI extensions version 2025-07 or higher and POS app version 9.31.0 or later.

The post-return screen appears after merchants complete a return transaction. This screen displays the return summary including returned items, refund amounts, and return reason, providing opportunities for customer service and follow-up actions.

Anchor to Use casesUse cases

  • Product returns: Display return reasons, product condition assessments, and restocking instructions.
  • Customer follow-up: Launch feedback collection, refund confirmations, and inventory adjustments.
  • Return analytics: Track return patterns, product quality issues, and satisfaction metrics.
  • External integrations: Connect with inventory management, quality control, and CRM (Customer Relationship Management) systems.

Anchor to Post-return targetsPost-return targets

Use these targets for return completion workflows, post-return analytics, or integration with external systems for return processing and follow-up.

Anchor to Post-return block ,[object Object]Post-return block target

pos.return.post.block.render

Renders a custom information section within the post-return screen. Use this target for displaying supplementary return data like completion status, refund confirmations, or follow-up workflows alongside standard return details.

Extensions at this target appear as persistent blocks within the post-return interface and support interactive elements that can launch modal workflows using shopify.action.presentModal() for more complex post-return operations.

Support
Components (15)
APIs (12)

Supported components

Available APIs

Anchor to Post-return action (menu item) ,[object Object]Post-return action (menu item) target

pos.return.post.action.menu-item.render

Renders a single interactive button component as a menu item in the post-return action menu. Use this target for post-return operations like generating return receipts, processing restocking workflows, or collecting return feedback.

Extensions at this target can access the order identifier through the Order API to perform return-specific operations. Menu items typically invoke shopify.action.presentModal() to launch the companion modal for complete post-return workflows.

Support
Components (1)
APIs (12)

Supported components

Available APIs

Anchor to Post-return action (modal) ,[object Object]Post-return action (modal) target

pos.return.post.action.render

Renders a full-screen modal interface launched from post-return menu items. Use this target for complex post-return workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.

Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.

Support
Components (34)
APIs (12)

Supported components

Available APIs

Anchor to Best practicesBest practices

  • Update return information in real time: Update displayed return information immediately when changes are made to reflect current state, like updated return status, refreshed inventory levels, and changed refund status.
  • Show clear action confirmations: Show clear success or error messages that specify which return was affected and what action was completed. Use messages like "Return #1001 processed successfully," "Refund initiated," or "Unable to process - system error".
  • Ensure return continuity: Ensure that post-return actions integrate properly with the overall transaction lifecycle and business processes, like updated inventory records, triggered refund workflows, and recorded return analytics.
  • Handle error states gracefully: Communicate return processing limitations clearly instead of generic error messages. If your extension processes return data or triggers post-return workflows, ensure you handle completion states responsibly, provide clear feedback about processing stages, and communicate any requirements or restrictions that affect return finalization or follow-up actions.
  • Write clear and action-oriented labels: Use action-oriented labels that specify what will happen for this particular return, with descriptive titles that clearly indicate the information type. Use "Process refund" or "Return Summary" instead of generic labels like "Return options" or "Return App."
  • Show status and return information: Show current return status, relevant metrics, and action eligibility to support completion decisions, like return completion status, "Return processed successfully," and return ID and refund details.

Anchor to LimitationsLimitations

  • You can only render one button component for each POS UI extension using the action (menu item) target.

  • Order data is read-only through the Order API, which provides only the order ID, name, and customer ID. To access additional return information or modify return data, use external API calls or integrate with the Admin API through your app backend.

Was this page helpful?