Locations

There are two ways you can add Parcelpoint locations to your checkout or returns page:

1. Location Widget
2. Location File Feed (CSV) (Not available for Pickup Address)

Location Widget (Recommended)

The location widget is the fastest and easiest way to display the Parcelpoint locations on your website, allowing customers to search and select their preferred location at checkout or on the returns page.

The widget can easily be customised (via CSS) to align to your website look and feel.

For the widget to function correctly, you must obtain a Google Maps API Key. Parcelpoint can not provide any Google API Keys.

Adding the script

To get started, include the following script tag on your checkout or returns page just before the </body>:

Production
<script type="text/javascript" src="https://widget.parcelpoint.com.au/widget/v3.1/stores"></script>

Staging
<script type="text/javascript" src="https://widget.staging.parcelpoint.com.au/widget/v3.1/stores"></script>

Displaying the widget

Next, create a HTML element in the part of the page you want to display the widget:

<div id="parcelpoint-widget"></div>

When your ready to initialise the widget, call parcelpoint.Store.init :

parcelpoint.Store.init({
    apiKey: "your-parcelpoint-api-key",
    initialAddress: '105 Kippax Street, Surry Hills, NSW 2010',
    targetDiv: "parcelpoint-widget",
    storeType: "full",
    initialView: "map",
    selectFirstStore: true,
    yourLocationMarker: true,
    features: ["CCF"],
    googleAPIKey: "your-google-api-key"
});
parcelpoint.Store.display();

Features

Not all locations offer all of Parcelpoint's services, and therefore need to be filtered out when offering to these services to customers. Below are a list of parameters you can use within the initialisation code to filter these locations.

Location File Feed (CSV)

Alternatively you can create your own Parcelpoint widget using the Parcelpoint design guidelines. However this File Feed is not available for Pickup Address services. Request Access

Every day, Parcelpoint will upload a CSV file to a specified SFTP/FTP containing a list of all Parcelpoint agents, their opening hours and addresses.

The file will be uploaded using the following naming convention in CSV file format:

ParcelPoint_Active_PUDO_List_{retailerName}-YYYYMMDD

When a customer selects a Parcelpoint location, the location data (e.g. delivery address for a Pickup order) can be obtained via JavaScript code listening to widget events. This can be used to automatically fill out the checkout form on the customer’s behalf, leading to a better checkout experience.

parcelpoint.Property.onChange(["storeDetails"], function(key, value) {
    let storeId= value['storeId'],
    addressLine1 =  value['storeAddress1'],
    addressLine2 =   value['storeAddress2'],
    city =   value['storeCity'],
    state =   value['storeState'], 
    postcode =  value['storePostCode'];
});