Branded Tracking Page

This documentation outlines typical scenarios for branded tracking page related to Commerce API. For additional scenarios and further information, please refer to the index page.

1. Querying order or shipment details on the branded tracking page

By integrating order information into the AfterShip system through the Commerce API, you enable buyers to access detailed order and shipment information on your AfterShip Branded Tracking Pages. Buyers can retrieve their order details using several options, including the order number, phone number, email address, or tracking number.

1.1 Querying the order

To retrieve the details of an order, the buyer can use the order number along with one of the following pieces of information:

1. The buyer's phone number
2. The buyer's email address
3. The postal code of the buyer's address.

Branded tracking page templates labeled as 'legacy' do not include support for order look-ups using postal codes.

To allow buyers to query the order with this method, please ensure that the specified information is included when creating an order through the Commerce API. The table below outlines the required fields:

Commerce API Field Name	Description
order.number	Order number
order.customer.phones.*	The buyer's phone number
order.customer.emails.*	The buyer's email address
fulfillment.ship_to_location.address.postal_code	The postal code of the buyer's address.

1.2 Querying the shipment

As an alternative, buyers can query shipment details by providing only the tracking number. This will allow them to access information such as the shipment's current location or checkpoint status.

Due to privacy considerations, using this querying method will prevent the branded tracking page from displaying order details. This is because the buyer has not provided specific order information, such as the order number, phone number, or email address.

The table below outlines the required fields:

Commerce API Field Name	Description
fulfillment.trackings.*.tracking_number	Tracking number of the shipment

2. Segmentation

Please refer to this page for more detail about Segmentation feature.

To use the Segmentation feature, you should send the required order information to AfterShip via Order API according to the referencetable below:

Order Resource

Commerce API Field Name	Segmentation Condition Field Name
order_total	Order -> Total billing amount
tags	Order -> Order tag
number	Order -> Order number
items.*.sku	Product -> Product SKU
items.*.product_categories	Product -> Product type
items.*.product_tags	Product -> Product tag
shipping_address.country_region	Shipment -> Destination country/region
shipping_address.state	Shipment -> Destination state
shipping_address.postal_code	Shipment -> Destination postal code
name	Shipment -> Shipment title

Fulfillment Resource

Commerce API Field Name	Segmentation Condition Field Name
trackings.*.slug	Shipment -> Carrier
trackings.*.custom_fields	Custom field

3. Product Recommendation

The AfterShip product recommendation feature allows you to showcase the most relevant products to your customers by analyzing various behaviors and criteria. To use this feature, you need to import a minimum of order and product resources into AfterShip.

For configuring the product recommendation feature on the branded tracking page, please refer to this page.

4. Buy Online, Pickup In Store (BOPIS)

With Buy Online, Pickup In Store (BOPIS) tracking, shoppers will be able to track when and where to pick up their orders. Proactively communicate with customers, enabling them to prepare for order pickups. Businesses control the information in BOPIS tracking page and notifications.

For configuring the BOPIS feature on the branded tracking page, please refer to this page.