Order Entity

1. Order Submitted: Notifies when an order has been successfully submitted, allowing businesses to immediately begin processing or tracking the order.

{
  "entity" : "Order",
  "event" : "Submitted",
  "eventTime" : "2024-10-24T22:30:55Z",
  "recordId" : 15682573,
  "entityData" : {
    "reference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderMethod" : "PORTAL_ACCESS",
    "orderClassification" : "EQUIPMENT_PURCHASE",
    "originalOrderId" : null,
    "originalOrderReference" : null
  },
  "eventData" : {
    "status" : "OPEN",
    "orderDate" : "2024-10-24T22:30:51Z",
    "returnLabelUrl" : null
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

2. Order Processing: Alerts when an order enters the processing stage, indicating that operations staff have begun handling the order.

{
  "entity" : "Order",
  "event" : "Processing",
  "eventTime" : "2024-10-24T22:32:25Z",
  "recordId" : 15682573,
  "entityData" : {
    "reference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderMethod" : "PORTAL_ACCESS",
    "orderClassification" : "EQUIPMENT_PURCHASE",
    "originalOrderId" : null,
    "originalOrderReference" : null
  },
  "eventData" : {
    "processDate" : "2024-10-24T22:32:25Z"
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

3. Order Ready For QA: Alerts when an order enters the Quality Assurance stage, indicating that operations staff are verifying the order's contents, ensuring accuracy.

{
  "entity" : "Order",
  "event" : "ReadyForQA",
  "eventTime" : "2024-10-24T22:32:27Z",
  "recordId" : 15682573,
  "entityData" : {
    "reference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderMethod" : "PORTAL_ACCESS",
    "orderClassification" : "EQUIPMENT_PURCHASE",
    "originalOrderId" : null,
    "originalOrderReference" : null
  },
  "eventData" : {
    "status" : "READYFORQA"
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

4. Order Shipped: Provides notification when an order has been shipped, including details such as shipping date and tracking information, which is essential for customer communication and logistics planning.

{
  "entity" : "Order",
  "event" : "Shipped",
  "eventTime" : "2024-10-24T22:32:31Z",
  "recordId" : 15682573,
  "entityData" : {
    "reference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderMethod" : "PORTAL_ACCESS",
    "orderClassification" : "EQUIPMENT_PURCHASE",
    "originalOrderId" : null,
    "originalOrderReference" : null
  },
  "eventData" : {
    "status" : "SHIPPED",
    "shipDate" : "2024-10-24T22:32:28Z",
    "originalOrderCompleted" : true,
    "serialNumbers" : [ "47C097F3-BF5C-4D", "137EADDC-03F0-4C" ],
    "packages" : [ {
      "id" : 7796542,
      "trackingNumber" : "15EDD58F-63E0-4552-8E7C-0A5C5D6CF6B6",
      "carrier" : "UPS",
      "type" : "OUTBOUND"
    } ],
    "equipment" : [ {
      "id" : 9770739,
      "serialNumber" : "47C097F3-BF5C-4D",
      "product" : {
        "id" : 103377,
        "name" : "MAG, Mini MICR w/ RS-232, 22522003, Check Reader, New"
      }
    }, {
      "id" : 9770740,
      "serialNumber" : "137EADDC-03F0-4C",
      "product" : {
        "id" : 103377,
        "name" : "MAG, Mini MICR w/ RS-232, 22522003, Check Reader, New"
      }
    } ],
    "revFreight" : 0.0000,
    "finalShipment" : true
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

5. Order Cancelled: Informs when an order has been cancelled, enabling businesses to halt any further processing or dispatching related to that order.

{
  "entity" : "Order",
  "event" : "Cancelled",
  "eventTime" : "2024-10-24T22:33:53Z",
  "recordId" : 15682572,
  "entityData" : {
    "reference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderMethod" : "PORTAL_ACCESS",
    "orderClassification" : "EQUIPMENT_PURCHASE",
    "originalOrderId" : null,
    "originalOrderReference" : null
  },
  "eventData" : {
    "status" : "CANCELLED",
    "originalOrderCompleted" : true
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

6. Order Returned and Returned Holding: Notifies when an order has been returned, including instances where it may be held for reshipment, allowing for efficient handling of returns and reshipments.

{
  "entity" : "Order",
  "event" : "Returned",
  "eventTime" : "2024-10-24T22:38:02Z",
  "recordId" : 15682573,
  "entityData" : {
    "reference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderMethod" : "PORTAL_ACCESS",
    "orderClassification" : "EQUIPMENT_PURCHASE",
    "originalOrderId" : null,
    "originalOrderReference" : null
  },
  "eventData" : {
    "status" : "RETURNED",
    "returnDate" : "2024-10-24T22:38:02Z",
    "returnReason" : {
      "id" : 3,
      "description" : "Attempted Three Times"
    }
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

{
  "entity" : "Order",
  "event" : "ReturnedHolding",
  "eventTime" : "2024-10-24T22:50:50Z",
  "recordId" : 15682579,
  "entityData" : {
    "reference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderMethod" : "PORTAL_ACCESS",
    "orderClassification" : "EQUIPMENT_PURCHASE",
    "originalOrderId" : null,
    "originalOrderReference" : null
  },
  "eventData" : {
    "status" : "RETURNEDHOLDING",
    "returnDate" : "2024-10-24T22:50:49Z",
    "returnReason" : {
      "id" : 3,
      "description" : "Attempted Three Times"
    }
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

7. Order Reshipped: Notifies when an order has been reshipped, providing updates on the status of the replacement order.

{
  "entity" : "Order",
  "event" : "Reshipped",
  "eventTime" : "2024-10-24T22:52:27Z",
  "recordId" : 15682579,
  "entityData" : {
    "reference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderMethod" : "PORTAL_ACCESS",
    "orderClassification" : "EQUIPMENT_PURCHASE",
    "originalOrderId" : null,
    "originalOrderReference" : null
  },
  "eventData" : {
    "status" : "RESHIPPED",
    "shipDate" : "2024-10-24T22:50:12Z",
    "originalOrderCompleted" : true,
    "packages" : [ {
      "id" : 7796544,
      "trackingNumber" : "C248A5D2-755B-4A75-8CA0-8B114F133852",
      "carrier" : "UPS",
      "type" : "OUTBOUND"
    } ],
    "reshipmentOrderId" : 15682580,
    "equipment" : [ {
      "id" : 9770744,
      "serialNumber" : "7FBCBBCE-D2BF-43",
      "product" : {
        "id" : 103377,
        "name" : "MAG, Mini MICR w/ RS-232, 22522003, Check Reader, New"
      }
    }, {
      "id" : 9770743,
      "serialNumber" : "04ECAA55-C6BC-43",
      "product" : {
        "id" : 103377,
        "name" : "MAG, Mini MICR w/ RS-232, 22522003, Check Reader, New"
      }
    } ],
    "revFreight" : 0.0000,
    "finalShipment" : true
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}

8. Order BackOrderCreated: Alerts when a backorder is created, ensuring that inventory management systems are updated and that stock replenishment processes can be initiated.

{
  "entity" : "Order",
  "event" : "BackOrderCreated",
  "eventTime" : "2024-10-25T16:39:18Z",
  "recordId" : 15682582,
  "entityData" : {
    "reference" : null,
    "merchantId" : 132452,
    "mid" : "1234567890",
    "merchantName" : "Test Merchant",
    "orderMethod" : "PORTAL_ACCESS",
    "orderClassification" : "EQUIPMENT_PURCHASE",
    "originalOrderId" : null,
    "originalOrderReference" : null
  },
  "eventData" : {
    "backOrderId" : 15682583,
    "backOrderType" : "BACKORDER"
  },
  "client" : {
    "id" : 1,
    "name" : "ABC Processor"
  }
}