Developers
Showing the UPCS share_url
Use the share_url returned by UPCS in order pages, emails and driver apps so anyone can open the exact location from a single link.
Updated 14 October 2026 · 2 min read
Several UPCS responses include a share_url. It is a ready-made link to the location, so you do not have to construct one yourself. Showing it in the right places saves couriers and customers from copying coordinates by hand.
Where it comes from
- The embed
onSelectresult; see handling the onSelect response. - Resolve and generate responses.
- The lookup response.
Use the value as returned rather than assembling a URL by hand, because that keeps you correct if the link format changes.
Where to show it
- Order confirmation page and email: a "View delivery location" link.
- Admin order screen: so staff open the exact point in one click.
- Dispatch messages: include the link next to the code in text messages or notes to drivers.
- Support tickets: paste the link instead of asking for coordinates.
Example
<p>
Delivery location:
<strong id="code">PK-1A2B-3C4D</strong> ·
<a id="share" href="#" rel="noopener" target="_blank">Open location</a>
</p>
<script>
// result comes from onSelect or your own server response
document.getElementById('share').href = result.share_url;
</script>
Escape values when you output them into HTML. If you render the link server-side, use your template engine's escaping rather than string concatenation.
Store it or rebuild it?
Keeping share_url with the order is convenient, but the code is the durable identifier. Many systems store the code and fetch the link on demand through a lookup, optionally caching the result. See storing a UPCS code in your database.
Privacy note
The link identifies a precise place, which may be someone's home. Share it only with the people who need it, as discussed in location data and GDPR concepts.
Frequently asked questions
Where do I get the share_url?
It is returned by the embed onSelect callback, the resolve and generate endpoints, and the lookup endpoint.
Does the share link need the recipient to sign in?
The lookup page for a code is available at upcs.io/CODE; check the behaviour in your own test before promising anything specific to customers.
