- First Install
- Testing the Configuration
First Install 🔼
1. Install the TCG Locker App 🔼
Install the TCG Locker app on your Shopify site by clicking here. Click the "Install" button. If you have multiple Shopify sites linked to your account, select the relevant website first. Once your dashboard appears, click the "Install" button again. After installation, you will be redirected to TCG Locker settings page.
2. Configure General Settings 🔼
Under the "General" tab, fill in Company Name, The Courier Guys Locker API URL and The Courier Guys Locker API Key. The other fields in the general tab are optional.
3. Configure Address Settings 🔼
Expand the "Address" tab and choose a preferred value for the “The Courier Guys Locker Source” dropdown (either Locker or Street Address).
4. Select TCG Locker Source Locker 🔼
In the “Locker Number” field, select your preferred TCG Locker source locker. This is required so clients can choose Locker -> Door or Locker -> Locker at checkout.
5. Enter Company Address 🔼
Fill in your Street Address, Suburb, City, Province, Postal Code. The “Country” field is restricted to “South Africa.”
6. Enter Contact Details 🔼
Fill in your Contact Name, Email and Phone.
7. Select Locker Size 🔼
Under the “Locker” dropdown, choose the locker size that all orders will be restricted to (Extra Small, Small, Medium, Large, Extra Large). You can only have one locker size attached to your Shopify website.
8. Optional Settings 🔼
8.1 Add Carrier Rates to Shopify on Save 🔼
Available for most Shopify Plans (excludes monthly Basic Plan). It adds dynamic rates to your shipping.
8.2 Enable TCG Locker Confirmation 🔼
This notifies the merchant whether the customer has selected a locker. Once the order is placed, the customer can select their locker on the Thank You page.
9. Save Settings 🔼
Click the Save Settings button to save your configuration.
10. Finishing Steps 🔼
These finishing steps help to ensure the plugin is configured correctly.
10.1 Shipping Address Phone Number 🔼
Click the notification for Shipping Address Phone Number to load a popup with Shopify checkout settings. Ensure that the phone number for shipping addresses is required.
10.2 Shipping Address Email 🔼
Ensure that the Customer contact method is set to 'Email'.
10.3 Flat-Rate Shipping Methods 🔼
If you are on a Basic Plan or don't wish to use Carrier Rates, create 2 flat-rate shipping methods for your South African shipping zone, ensuring they include “Locker” or "locker" in their names (e.g., The Courier Guy Locker or The Courier Guy Locker to Door).
10.4 Locker Confirmation Thank You Page 🔼
Navigate to Settings → Checkout → Customize to configure the Thank You page. Enable the checkout-locker-select block under Apps to allow customers to select their locker destination after purchase.
10.5 Order Confirmation Email Template 🔼
If Enable The Courier Guy Locker confirmation is checked, go to Settings → Notifications → Customer notifications → Order Confirmation → Edit Code.
Paste the following code below the shipping info table (approximately line 3500, after the </table> in the unedited template), then save your changes:
{% if shipping_method and shipping_method.title | downcase contains 'locker' %}
{% assign shopName = shop.domain %}
{% assign orderID = order.id %}
{% capture locker_url %}
https://shp.pudo.co.za/otp_confirmation?shop={{ shopName }}&orderID={{ orderID }}
{% endcapture %}
<p style="margin:16px 0; font-size:16px;">
Please select your locker destination here:
<a href="{{ locker_url }}" style="color:#1a73e8; text-decoration:underline;">Click to choose locker</a>
</p>
<p style="color:#888; font-size:14px;">
If the link does not work, copy and paste this URL into your browser:<br>
{{ locker_url }}
</p>
{% endif %}
Your order confirmation email should now contain the newly added code:
Testing the Configuration 🔼
1. Prime Checkout 🔼
Navigate to the front end of your Shopify store, add a product to your cart and navigate to the Checkout page.
2. Select TCG Locker Method 🔼
Add your shipping address and select the TCG Locker method at checkout. You will be able to confirm your TCG Locker selection on the Thank You page after completing your order. Ensure you have access to the email used at checkout, as it will receive the OTP pin required to submit your shipment.
3. Complete TCG Locker Destination Selection 🔼
On the Thank You page, click the Confirm button.
4. Enter OTP and Confirm 🔼
Navigate to your email to retrieve the OTP, enter it, select your Locker destination, and click Continue.
