Skip to content

Call Tag Entity

Daniel Chally edited this page Nov 20, 2024 · 1 revision
  1. Call Tag Created: Alerts when a call tag (a request for the return of merchandise) is created, enabling efficient management of returns logistics.
{
  "entity" : "CallTag",
  "event" : "Created",
  "eventTime" : "2024-10-25T16:54:14Z",
  "recordId" : 1249885,
  "entityData" : {
    "orderId" : 15682585,
    "orderReference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "orderClassification" : "CALLTAG_ONLY"
  },
  "eventData" : {
    "status" : "OPEN",
    "createDate" : "2024-10-25T16:54:13Z",
    "expectedItemCount" : 1,
    "items" : [ {
      "id" : 1553705,
      "returnType" : "RETURN",
      "reason" : {
        "id" : 2,
        "description" : "Wrong Item Ordered"
      },
      "deployedEquipmentId" : 9770748,
      "expectedProduct" : {
        "id" : 103376,
        "name" : "MAG, Mini MICR w/ RS-232, 22522003, Check Reader"
      },
      "expectedSerialNumber" : "D91DD56C-81D5-45"
    } ]
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}
  1. Call Tag ItemsReceived: Notifies when items have been received on a call tag, allowing businesses to update inventory and manage returns.
{
  "entity" : "CallTag",
  "event" : "ItemsReceived",
  "eventTime" : "2024-10-25T17:01:41Z",
  "recordId" : 1249885,
  "entityData" : {
    "orderId" : 15682585,
    "orderReference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "orderClassification" : "CALLTAG_ONLY"
  },
  "eventData" : {
    "status" : "OPEN",
    "expectedItemCount" : 1,
    "receivedItemCount" : 1,
    "deliquent" : false,
    "items" : [ {
      "id" : 1553705,
      "returnType" : "RETURN",
      "reason" : {
        "id" : 2,
        "description" : "Wrong Item Ordered"
      },
      "deployedEquipmentId" : 9770748,
      "expectedProduct" : {
        "id" : 103376,
        "name" : "MAG, Mini MICR w/ RS-232, 22522003, Check Reader"
      },
      "expectedSerialNumber" : "D91DD56C-81D5-45",
      "receivedProduct" : {
        "id" : 103376,
        "name" : "MAG, Mini MICR w/ RS-232, 22522003, Check Reader"
      },
      "receivedSerialNumber" : "D91DD56C-81D5-45",
      "receivedDate" : "2024-10-25T17:00:48Z"
    } ]
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}
  1. Call Tag DelinquentBilling: Informs when items expected to be returned under a replacement agreement are not received within the specified timeframe, triggering billing for delinquency.
{
  "entity" : "CallTag",
  "event" : "DelinquentBilling",
  "eventTime" : "2024-10-25T17:49:19Z",
  "recordId" : 1249889,
  "entityData" : {
    "orderId" : 15682797,
    "orderReference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "orderClassification" : "REPLACEMENT_NON_RENTAL"
  },
  "eventData" : {
    "status" : "CLOSED_BY_BILLING",
    "expectedItemCount" : 1,
    "items" : [ {
      "id" : 1553709,
      "returnType" : "REPLACEMENT",
      "reason" : {
        "id" : 1,
        "description" : "Unit not operating, no power"
      },
      "deployedEquipmentId" : 9770754,
      "expectedProduct" : {
        "id" : 103376,
        "name" : "MAG, Mini MICR w/ RS-232, 22522003, Check Reader"
      },
      "expectedSerialNumber" : "DDF24628-78D9-44",
      "delinquentOrderId" : 15682798
    } ]
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}
  1. Call Tag ItemsReceived (After Delinquent Billing): Updates when delinquent items are eventually returned, ensuring that inventory and billing records are adjusted accordingly.

  2. Call Tag Cancelled: Notifies when a call tag has been cancelled, helping businesses manage and update their returns processes.

{
  "entity" : "CallTag",
  "event" : "Cancelled",
  "eventTime" : "2024-10-25T17:12:27Z",
  "recordId" : 1249887,
  "entityData" : {
    "orderId" : 15682593,
    "orderReference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "orderClassification" : "CALLTAG_ONLY"
  },
  "eventData" : {
    "status" : "CANCELLED",
    "expectedItemCount" : 1,
    "items" : [ {
      "id" : 1553707,
      "returnType" : "RETURN",
      "reason" : {
        "id" : 2,
        "description" : "Wrong Item Ordered"
      },
      "deployedEquipmentId" : 9770751,
      "expectedProduct" : {
        "id" : 103376,
        "name" : "MAG, Mini MICR w/ RS-232, 22522003, Check Reader"
      },
      "expectedSerialNumber" : "21388BD2-FEF7-4C"
    } ]
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

Clone this wiki locally