Order Item QR Scanned (order_items.qr_code_scanned)

Description

This event occurs when a QR code is scanned on an order item. It ensures that systems remain informed about scans on individual items within an order, providing real-time updates and synchronization.

Trigger Conditions

This webhook is triggered when a QR code on an order item is scanned.

Purpose

This webhook enables systems to track QR code scans for individual order items, ensuring transparency and efficient communication. Additionally, it helps external systems stay synchronized with the latest order item information.

Use Cases

• External systems can react to scans by tracking order items.
• User-facing notifications can be updated to reflect the most recent scan data.
• Third-party tools or systems can leverage this webhook to enhance order management workflows and provide real-time insights.

Example Payload

{
  "event": "order_item.qr_code_scanned",
  "data": {
    "scanned_by": {
      "contact_first": "John",
      "contact_last": "Doe",
      "contact_company": "Company Inc",
      "contact_email": "[email protected]"
    },
    "scan_timestamp": "1/23/2025 9:58AM EST",
    "number_of_scans": "2",
    "order_details": {
      "order_id": "1558",
      "order_name": "testing"
    },
    "utm_details": {
      "utm_source": "dummy data",
      "utm_medium": "dummy data",
      "utm_campaign": "dummy data",
      "utm_email": "dummy data",
      "utm_phone": "dummy data",
      "utm_property_address": "dummy data"
    }
  },
  "token": "YOUR_WEBHOOK_SECRET_KEY"
}

Parameters

• event (String): The type of event that triggered the webhook.
• data (Object): Contains information about the scanned order item.
• scanned_by (Object): Information about the person who scanned the order item.
  • contact_first (String): First name of the person who scanned the order item.
  • contact_last (String): Last name of the person who scanned the order item.
  • contact_company (String): Company name of the person who scanned the order item.
  • contact_email (String): Email address of the person who scanned the order item.
• scan_timestamp (String): Timestamp of the scan.
• number_of_scans (String): Number of times the order item was scanned.
• order_details (Object): Information about the order associated with the scanned item.
  • order_id (String): Unique identifier for the order.
  • order_name (String): Name of the order.
• utm_details (Object): Information about the UTM details associated with the scan.
  • utm_source (String): Source of the UTM details.
  • utm_medium (String): Medium of the UTM details.
  • utm_campaign (String): Campaign of the UTM details.
  • utm_email (String): Email of the UTM details.
  • utm_phone (String): Phone number of the UTM details.
  • utm_property_address (String): Property address of the UTM details.
• token (String): Your secret webhook token.

Conclusion

The order_item.qr_code_scanned webhook provides vital information about QR code scans made on individual items within orders in Open Letter Connect, allowing external systems to respond effectively. By following best practices regarding security, error handling, and testing, you can ensure a smooth integration experience.