Skip to main content

Order Tracking

  • Updated

 

Pre-Requisites

 

How to Implement Order Tracking 

1. Verify Order Details

  1. Log in to the Merchant’s BigCommerce Admin.
  2. Navigate to Shipments.
  3. Inspect shipment details to verify carrier and tracking information is provided. 

 

2. Create Webhooks 

Obtain Division Values  

  1. Log in to Bolt Admin. 
  2. Navigate to Merchant Lookup > [Merchant Account Name] > [Merchant Division Name]
  3. Obtain the following IDs from the division:
    1. Public Division ID: Found in Division Summary 
    2. Store Hash ID: Found in the APIHook URL after /store/. 
    3. Consumer Key: Found in relation to bigcommerce_oauth
    4. Token:  Found in relation to bigcommerce_oauth

Submit Postman Test 

  1. Log in to Postman.
  2. Create a POST request sent to the following URL:
    • https://api.bigcommerce.com/stores/<store_hash>/v2/
  3. Navigate to Headers add the following: 
    • Accept: application/json
    • Content-Type: application/json 
    • X-Auth-Client: <Consumer Key>
    • X-Auth-Token: <Token>
  4. Navigate to Body and select raw. 
  5. Update the Body with the following: 
    {
"scope": "store/shipment/*",
"destination": "https://api.bolt.com/v1/webhooks/bigcommerce/",
"is_active": true
}
  1. Send the request.
  2. Monitor in DataDog across the next 2 days.

 

3. Set Up Merchant’s Phone Number 

Register With Twilio

  1. Log in to Bolt’s Twilio account.
  2. Navigate to the Product sub-account.
  3. Buy a new phone number.
  4. Update the Friendly Name to the Merchant’s Division/Storename. 
  5. Update the Incoming Message Webhook to the following:
    https://api.bolt.com/v1/webhooks/twilio/sms_response
  6. Copy the phone number and proceed to the next section.

Add Phone to Production Database

  1. Log in to Bolt’s production database.
  2. Add the phone number to the merchant_sms_numbers field. Remove any spaces. 
  3. Update the merchant_sms_autoreply field with a custom response provided by the merchant (if applicable). 
  4. In Bolt Admin, ensure the Merchant Division’s support email and Support Page URL are accurate.

 

4. Set up Tracking Page & Links 

  1. Log in to Bolt’s production database.
  2. Navigate to the merchant’s merchant_settings table.
  3. Update the account_hostpage_url to point to a storefront url that has the Bolt account script embedded, such as the homepage. 
  4. Log in to the merchant’s BigCommerce backend.
  5. Make a copy of the merchant’s current theme.
  6. Add the following script to their footer (typically found in templates/components/common.footer.html).  
    <!--Bolt Addition-->

    <div>

        <div class="bolt-account-login"></div>
        <script 

    id="bolt-account"
    type="text/javascript"
    src="https://connect.bolt.com/account.js"

    data-publishable-key={publishable_key}>

        </script>

    </div>

    <!--End Bolt Addition-->
  7. Refresh the page and preview the theme and inspect element to see that the div is in the right place and that the Bolt button is rendered (even if it’s invisible).
  8. Publish the theme.
  9. Navigate to the account_hostpage_url.
  10. Append ?transactionReference=123&trackingNumber=123&carrier=abc. 
  11. Verify that the signing modal appears. 
  12. Navigate to Storefront > Email Templates in the Merchant’s BigCommerce backend. 
  13. Edit Invoice.html.
  14. Add the following tracking link beneath %%GLOBAL_PendingPaymentDetails%%: 
    %%GLOBAL_PendingPaymentDetails%% %%GLOBAL_OrderCommentBlock%%

Order Tracking Link %%GLOBAL_ShopPathSSL%%?orderNumber=%%GLOBAL_OrderNumber%%
  15. Save.

5. Enable Division Feature

  1. Log in to Datadog and review logs to ensure the following:
    • There are no errors
    • That shipped orders have tracking numbers
    • That Tracking numbers are working properly with tracking vendors.
  2. Navigate to the Bolt Admin Dashboard and enable the following division features:
    • “Send links in to the shopper dashboard when a customer opts in to order notifications”
    • “Enable a checkbox for customers to opt in to text based shipping notifications”
    • “Send tracking links in order confirmation email and SMS”
    • “Forward customer SMSs as support tickets to merchant support email address”

 

6. Test

  1. Navigate to the merchant’s storefront.
  2. Add an item to your cart.
  3. Open checkout. On the page with delivery options, you should see a checkbox that prompts you to sign up for order updates via text.
  4. Let the merchant know the feature is on. Example:
    • “We’ve turned on this feature for your site, enabling your shoppers to opt into SMS updates and use a branded tracking page! We’ll be monitoring your orders and shipments over the next few days to ensure everything is moving smoothly. If you have any questions, please feel free to email me.”