UPCS Logo
    My Account

    Developers

    Magento and UPCS: A Conceptual Approach

    UPCS has no ready-made Magento extension. This conceptual guide outlines how a developer could combine the embeddable map and REST API in Magento.

    Updated 14 October 2026 · 2 min read

    Plainly: UPCS has no ready-made extension for Magento. If you run Magento and want customers to pin a delivery location, you would build the integration yourself using the embeddable map and the REST API. This page is conceptual; it describes an approach, not a tested module.

    What exists today

    UPCS provides plugins for WordPress/WooCommerce, PrestaShop and OpenCart, available on the plugins page. For other platforms, the public API is the integration boundary: a server-created embed session, the browser map, and server-to-server endpoints.

    Conceptual building blocks

    1. A small server-side component. A custom module (or a service next to Magento) holds the UPCS API key and creates embed sessions with POST /v1/embed/sessions. The key lives in configuration or a secret store, never in a template. See securing your UPCS API key.
    2. A frontend block in checkout. A template or UI component loads the embed script and calls UPCS.mount, as in embed the map on a website. The onSelect callback fills hidden values.
    3. Persistence. The selected code and coordinates need a place to live, such as extra fields on the quote and order, or a separate table keyed by order id. Compare saving the code with an order.
    4. Verification. On order placement, the server looks up the code before saving it: look up a UPCS code.
    5. Display. Show the code and share link on the admin order page and in order emails: showing the share_url.

    Things to plan

    • Registering every storefront origin, including staging, under allowed origins.
    • A graceful fallback when the map is unavailable, so checkout never breaks.
    • Respecting the key's hourly limit, with caching and backoff.
    • Magento's own conventions for modules, layout and checkout customisation, which are outside the scope of UPCS.

    No official SDK is involved; see is there a UPCS SDK.

    Frequently asked questions

    Is there a UPCS extension for Magento?

    No. There is no ready-made Magento extension. Integration is possible through the embeddable map and the REST API.

    Which stores have ready-made plugins?

    WordPress/WooCommerce, PrestaShop and OpenCart. They can be downloaded from the plugins page.

    Related reading

    Laravel Example: Create a UPCS Embed SessionA Laravel controller and route that use the HTTP client to create a UPCS embed session with your API key and return the session token to the page.Django Example: Create a UPCS Embed SessionA Django view and URL route that call the UPCS embed session API with requests and return a session token as JSON for your page.Express Example: Create a UPCS Embed SessionAn Express.js route that creates a UPCS embed session with fetch, rate limits itself and returns only the session token to the browser.North American Address Format ExplainedUnited States and Canadian addresses follow a number-street-city-region-code layout. Learn the typical lines, unit notation and how to write them.