Skip to content

Package Entity

Daniel Chally edited this page Nov 20, 2024 · 1 revision
  1. OrderPackage DeliveryConfirmed: Confirms when a package has been delivered, which is crucial for closing out transactions and ensuring customer satisfaction.
{
  "entity" : "OrderPackage",
  "event" : "DeliveryConfirmed",
  "eventTime" : "2024-10-25T16:51:27Z",
  "recordId" : 7796545,
  "entityData" : {
    "trackingNumber" : "8171E199-1098-4E40-A075-5036E12411FE",
    "carrier" : "UPS",
    "orderId" : 15682584,
    "orderReference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderClassification" : "EQUIPMENT_PURCHASE"
  },
  "eventData" : {
    "deliveryTime" : "2024-10-25T16:51:27Z",
    "signedBy" : "Test User"
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}
  1. OrderPackage DeliveryExpired and DeliveryFailed: Notifies when a package delivery could not be confirmed or failed, allowing businesses to take corrective action or communicate with customers.
{
  "entity" : "OrderPackage",
  "event" : "DeliveryExpired",
  "eventTime" : "2024-10-25T16:41:35Z",
  "recordId" : 7796543,
  "entityData" : {
    "trackingNumber" : "CDB8DB16-7BDF-4C69-AFB7-8A210898B8D0",
    "carrier" : "UPS",
    "orderId" : 15682576,
    "orderReference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderClassification" : "EQUIPMENT_PURCHASE"
  },
  "eventData" : null,
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}
{
  "entity" : "OrderPackage",
  "event" : "DeliveryFailed",
  "eventTime" : "2024-10-25T16:41:35Z",
  "recordId" : 7796542,
  "entityData" : {
    "trackingNumber" : "15EDD58F-63E0-4552-8E7C-0A5C5D6CF6B6",
    "carrier" : "UPS",
    "orderId" : 15682573,
    "orderReference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderClassification" : "EQUIPMENT_PURCHASE"
  },
  "eventData" : null,
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

Clone this wiki locally