Event schemas

The following describes the properties available to include in the JSON schemas for events related to ORDERS

{
  "eventType": "ORDER.CREATED",
  "version": "v1",
  "orderNumber": "XXX",
  "email" : "[email protected]",
  "shippingAddress": "1st line of address with city, country and post/zip code. maybe state as well",
  "productCode": "PRODUCT-CODE"
}

{
  "eventType": "ORDER.DISPATCHED",
  "version": "v1",
  "orderNumber": "XXXX",
  "email" : "[email protected]",
  "trackingUrl" : "http://example.com",
  "dispatchedAt": "2022-03-07T16:13:42.345Z",
  "productCode": "PRODUCT-CODE"
}

{
  "eventType": "ORDER.OUT_FOR_DELIVERY",
  "version": "v1",
  "orderNumber": "XXXX",
  "email" : "[email protected]",
  "trackingUrl" : "http://example.com",
  "dispatchedAt": "2022-03-07T16:13:42.345Z",
  "productCode": "PRODUCT-CODE"
}

{
  "eventType": "ORDER.RECEIVED",
  "version": "v1",
  "orderNumber": "XXXX",
  "email" : "[email protected]",
  "trackingUrl" : "http://example.com",
  "dispatchedAt": "2022-03-07T16:13:42.345Z",
  "productCode": "PRODUCT-CODE"
}

The following describes the properties available to include in the JSON schemas for events related to TESTS

{
  "eventType": "TEST.REGISTERED",
  "version": "v1",
  "orderNumber": "YYY",
  "kitId": "FRXXX",
  "productCode": "XXX",
  "firstName": "John",
  "email": "[email protected]",
  "testTitle": "Example test"
}

{
  "eventType": "TEST.LAB_ACCESSIONED",
  "version": "v1",
  "testId": "620ce889de8cf1cbe9c370e11",
  "orderNumber": "XXX",
  "kitId": "FRXXX",
  "productCode": "XXX",
  "partnerUserId" : "XXX"
}

{
  "eventType": "TEST.PROCESSED",
  "version": "v1",
  "testId": "620ce889de8cf1cbe9c370e11",
  "orderNumber": "XXX",
  "kitId": "FRXXX",
  "productCode": "XXX",
  "partnerUserId" : "XXX"
}

{
  "eventType": "TEST.CLINICAL_COMMENTARY_UPLOADED",
  "version": "v1",
  "testId": "620ce889de8cf1cbe9c370e11",
  "orderNumber": "XXX",
  "kitId": "FRXXX",
  "productCode": "XXX",
  "partnerUserId" : "XXX"
}