Order Tracker

The Order Tracker component displays shipping and tracking information for customer orders within the chat interface.

Example

{
  "type": "orderTracker",
  "payload": {
    "status": "Delivered",
    "carrier": "Royal Mail",
    "shippingMethod": "Standard",
    "trackingNumber": "AUP12345-45",
    "trackingLink": "https://example.com?x=AUP12345-45",
    "lastUpdatedDate": "2025-03-10T00:00:00",
    "expectedDeliveryDate": "2025-03-28T00:00:00",
    "shippingMethodDaysRange": "15-20",
    "shipmentNumber": 1,
    "totalShipments": 2,
    "productImages": [
      "https://example.com/product1.jpg",
      "https://example.com/product2.jpg"
    ],
    "proofOfDelivery": {
      "image": "https://example.com/pod.jpg"
    },
    "trackingHistoryItems": [
      {
        "date": "2025-03-11T00:00:00",
        "status": "In Transit",
        "description": "More details about this stage"
      }
    ]
  }
}

Properties

payload

• status: Current order status (e.g., "Delivered", "In Transit", "Out for Delivery").
• carrier: Name of the shipping carrier (e.g., "Royal Mail", "DHL").
• shippingMethod: The delivery service type (e.g., "Standard", "Express").
• lastUpdatedDate: ISO date string of when the tracking was last updated.
• shippingMethodDaysRange (optional): Expected delivery timeframe (e.g., "15-20").
• expectedDeliveryDate (optional): ISO date string of the expected delivery date.
• trackingNumber (optional): The unique tracking reference for the shipment.
• trackingLink (optional): When provided, the tracking number will link to the tracking info on the carriers website.
• proofOfDelivery (optional): Object containing delivery confirmation:
  • image: URL of the proof of delivery image.
• productImages (optional): Array of URLs for product images in the order.
• productNames (optional): Array of product names in the order.
• totalShipments (optional): Total number of separate shipments in the order.
• shipmentNumber (optional): Current shipment number being displayed.
• trackingHistoryItems (optional): Array of tracking events:
  • date: ISO date string of when the event occurred.
  • status: Status description of the tracking event.
  • description: (optional) Detailed description of the tracking event.