Skip to main content

Developer reference

Custom list

Custom list lets you offer your own locations as pickup points: your shops, showrooms, warehouses, or partner stores. You add each location in Shopify Admin and Atlas stores the list for you, so there is no endpoint to host and nothing for a developer to build. Each store can hold up to 5,000 locations.

Like Custom endpoint, Custom list is available on the Pro and Enterprise plans. See Pricing for the plan comparison.

#Custom list or Custom endpoint

Both providers let you bring your own pickup points. Choose based on how often your locations change:

Custom list Custom endpoint
Where the locations live In Atlas, entered in Shopify Admin On your server, returned per request
Best for Locations that change rarely: your shops, warehouses, partner stores Locations that change from one request to the next, or come from a live system
Developer needed No Yes
Loading at checkout Served from Atlas, no external call Depends on your endpoint’s response time
When your systems are down Checkout keeps working Pickup points are not displayed
Search at checkout Always on Optional, implemented by your endpoint

#How it works

In Shopify Admin → Atlas Pickup Points, open the pickup point configuration, select the country, and select Custom list as the provider. The Your locations panel appears below the provider. Click Add locations (or Manage once the list has locations in that country) to open the list editor.

Your store has one list of locations shared by all pickup point configurations. Each configuration serves a single country, so buyers only see the locations in that configuration’s country. The country list in the editor shows the countries where Custom list is available.

To offer only some of the locations in a country, add a filter in the Filters section of the configuration, for example on the location type. Configurations that serve the same country can each use different filters. See How to conditionally hide delivery to pickup points for how to split a provider into separate configurations.

At checkout, Atlas shows the locations nearest to the buyer’s shipping address, or to the position of the map if the buyer moves it. Buyers can search the list by location name, street, city, or postal code, and the configuration’s filters (such as location type) apply in the same way as for carrier pickup points.

#Adding a location

In the list editor, click Add location and fill in the form.

Field Required Description
Location name Yes Shown to the buyer as the pickup point name.
Code Yes Your own identifier for the location, unique within your list. Buyers never see it. Atlas stores it on the order, so use the identifier your fulfillment system knows.
Type Yes PUDO for a staffed counter or APM for a locker. Used by the location type filter in the configuration.
Description No Shown under the name at checkout. Use it for hints such as “second floor” or “next to the pharmacy”.
Country/region Yes Determines which configurations serve the location.
Street and house number Yes Shown to the buyer together with the city.
Apartment, suite, etc. No Click Add second address line to reveal it.
Postal code Yes Required in every country except Romania.
City Yes
Province No Only shown for countries with provinces or states.
Latitude and longitude Yes Position the location on the map. In Google Maps, right-click the location and click its coordinates to copy them.
Opening hours No See below.
Active Yes On by default. Turn it off to hide the location from checkout without deleting it.

#Opening hours

Add one or more periods per day of the week. A day without a period is shown as closed. Add a second period to a day to model a lunch break. Times are local to the location and are not converted to the buyer’s time zone.

Turn on Open 24 hours for locations that are always open, such as a locker. Buyers see this instead of a weekly schedule.

#Managing the list

The list editor shows all your locations with their status, code, address, and type. You can:

  • Search by name, code, city, or postal code.
  • Filter by country and by status (All, Active, Disabled).
  • Select locations to Enable, Disable, or Delete them in bulk.

#Disabling a location

Disable a location to hide it from checkout while keeping everything you entered. Use this for temporary closures such as renovations or holidays. Enable it again to bring it back.

Disabled locations count toward the 5,000 location limit.

#Deleting a location

Deleting a location removes it permanently and cannot be undone. To hide a location only for a while, disable it instead.

#Order data

Atlas saves the selected location to the order in the same way as for any other provider. The provider field of the order metafield is CUSTOM_LIST and the code field contains the location’s code exactly as you entered it. See the integration guide for the metafield structure.

#Uninstalling the app

Uninstalling the app deletes your list together with your pickup point configurations and the rest of your data. If you reinstall later, you need to add the locations again. If you plan to reinstall, keep a copy of your locations outside Atlas.

#Keeping the list in sync with your own system

We are working on an API that replaces the list from your own server, so you can sync it with your store locator, ERP, or a nightly export. It is available in early access. Contact us if you would like to use it.