B2C Commerce Cloud Tracking Pages
Provide Real-time order status of orders and shipments. You can add your own steps e.g. "Product being build" and customize the page. The recommendations are powered by Content Slots and Einstein AI.
Install the Zenkraft Cartridge
Zenkraft supports both SiteGenesis and SFRA. Our live documentation is in SFRA but please contact us for SiteGenesis documentation.
In order to use the int_zenkraft_sfra cartridge, it needs to be assigned to your site through Administration -> Sites -> Manage Sites -> Your Site -> Settings tab. Add the cartridge to the left of your base cartridge because there are several methods and models that are extending via the Zenkraft cartridge.
Configure the Cartridge
In order to function correctly, there are several imports that need to be done. All of these imports can be found in the metadata folder of the integration.
zenkraft-sys-object-import.xml - This contains all of the system object definitions and custom site preference definitions, as well as a custom object definition for Shipment Notifications. Import it at Administration -> Site Development -> Import & Export -> Meta Data Import
zenkraft-dropoff-sys-object-import.xml - This contains all of the system object definitions and custom site preference definitions that are related to the Drop Off Shipments Feature ONLY. Import it at Administration -> Site Development -> Import & Export -> Meta Data Import
zenkraft-services-import.xml - This import contains the Salesforce Commerce Cloud Service Framework definitions for connecting to the Zenkraft API. Import it at Administration -> Operations -> Import & Export -> Services
zenkraft-jobs-import.xml - This import contains the job that sends shipment notifications. Import it at Administration -> Operations -> Import & Export -> Job Schedules
Setup Tracking Pagess
Custom Preference Configuration
There are several custom site preferences that can be set. Some are essential to connecting to the Zenkraft API and some allow you to enable/disable/customize certain pieces of functionality. The following preference is in the Zenkraft and Zenkraft Returns preference groups. All of the following preferences are in the Zenkraft and Zenkraft Returns preference groups.
Zenkraft Group Preferences
|Zenkraft Master API Key||You will need to get this from Zenkraft. The API key is required for all API calls.|
|Zenkraft Production Mode||Allows you to toggle between production mode and development mode.|
|Enable Zenkraft Shipping Methods||Allows you to toggle the Real-Time Shipping Rates for Shipping Methods|
|Enable Zenkraft Shipping Rates||Allows you to toggle the Real-Time Shipping Rates for Shipping Methods|
|Enable Zenkraft Estimated Delivery Dates||Enables estimated delivery dates to be shown in checkout. These will replace the static Estimated Arrival that can be set on the shipping method in Business Manager.|
|Carrier ID||Carrier ID to use for Shipments to the customer.|
|Packaging Type||Packaging type to use for shipments to the customer. Values can be found in Zenkraft API documentation.|
|Shipping Account ID||ID Number for the Carrier account for shipments to the customer.|
|Currency Code||Currency Code to use with the Zenkraft API. Default value is USD and available values can be found in the Zenkraft API documentation.|
|Dimension Units||Units to be used for dimensions.|
|Weight Units||Units to be used for weight.|
|Default Product Weight||This is the default weight to be used for products when determining shipping rates. If the weight is not defined on the product, this is what is used.|
|Sender Street Address||This is the address used as the FROM address for shipments to the customer.|
|Sender Address City||This is the city used as the FROM city for shipments to the customer.|
|Sender Address State Code||This is the state code used as the FROM state code for shipments to the customer. This is optional as not all countries have states.|
|Sender Address Postal Code||This is the postal code used as the FROM postal code for shipments to the customer.|
|Sender Address Country Code||This is the country code used as the FROM country code for shipments to the customer.|
|Sender Company||This is the Company Name used as the FROM company name for shipments to the customer.|
|Sender Name||This is the name used as the FROM name for shipments to the customer.|
|Sender Phone Number||This is the phone number used as the FROM phone number for shipments to the customer.|
|Sender Email Address||This is the email address used as the FROM email address for shipments to the customer.|
Zenkraft Rates Group Preferences
|Carrier ID||Carrier ID to use for Return Labels|
|Packaging Type||Packaging type to use for Return Labels. Values can be found in Zenkraft API documentation.|
|Shipping Account ID||ID Number for the Carrier account for return shipments.|
|Recipient Street Address||This is the address used as the TO address for returns.|
|Recipient Address City||This is the city used as the TO city returns.|
|Recipient Address State Code||This is the state code used as the TO state code for returns. This is optional as not all countries have states.|
|Recipient Address Postal Code||This is the postal code used as the TO postal code for returns.|
|Recipient Address Country Code||This is the country code used as the TO country code for returns.|
|Recipient Company||This is the Company Name used as the TO company name for returns.|
|Recipient Name||This is the name used as the TO name for returns.|
|Shipping Service||This is the shipping service that is used for returns. Available values for your carrier can be found in the Zenkraft API documentation.|
|Recipient Phone Number||This is the phone number used as the TO phone number for returns.|
|Recipient Email Address||This is the email address used as the TO email address for returns.|
|Shipping Label File Type||The file type to be used for shipping labels. Check the Zenkraft API documentation to see the available values for each carrier.|
Zenkraft Advanced Configuration
|Enable Advanced JSON Configuration||If this is enabled, the other carrier and address settings in the Zenkraft site preference groups will be overridden by the JSON provided in the next site preference in this group..|
|Zenkraft Advanced JSON Object||
This is the object used for the advanced configuration. Out of the box, the json specifies ship
preferences and return preferences, and allows for different configurations per country. This
JSON could be changed (along with a code change in ZenkraftHelper.js) to allow for other
configurations, such as separate settings for carriers instead of country.
|Enable Zenkraft Tracking Page||Enables the tracking page via the Zenkraft-Track route.|
|Zenkraft Tracking Settings JSON||
JSON configuration for shipping account settings on the Tracking Page. This allows for
multiple carriers and different shipping accounts per carrier.
Esample JSON value:
Shipment Tracking Page
The shipment tracking page is available from the Zenkraft cartridge through the Zenkraft-Track route. The controller expects query string parameters in order to show the proper tracking and order information to the customer. The parameters include ‘tracknumber’, which is the tracking number, ‘carrier’ for the carrier, and ‘order’ for the order ID. ‘order’ is an optional parameter. If it exists then the user is shown the line items on their order. If it does not exist, then the section is not displayed.
The shipment tracking page also allows users to subscribe to shipment notifications when their shipment status has changed. For example, they could be notified when their shipment is out for delivery. Currently, our cartridge supports SMS, WhatsApp and Facebook Messenger notifications.
One of the best things about the shipment tracking page is that once you have the Zenkraft cartridge set up, there’s no custom code needed in order to get it up and running. It is available at the Zenkraft-Track endpoint of your existing site.
To enable, just set the site preference to true and include your shipping account settings JSON. For more information, see the Site Preferences section below.
Shipment Tracking URL
In order to send your customers to the shipment tracking page, you’ll need to construct the URL in the correct format. As mentioned earlier, the Zenkraft-Track route is where you’ll send them. The URL requires two query string parameters: tracknumber and carrier, with an optional order parameter
- tracknumber: the tracking number associated with this shipment
- carrier: thte carrier associated with this shipment
- order: the SFCC order number
You can also set up seo-friendly URLs so that your resulting URL will look something like: https://www.yourbrandedsite.com/trackshipment?tracknumber=123456789&order=N1231231
Please contact us for any more information and for next steps.