Biospecimens: Incorporate FedEx API for tracking shipments

[brotzmanmj]

Incorporate FedEx API to get current shipping status information on packages in transit from sites and mouthwash kits. First step, call the API and receive and store the data. In a later step we will determine what to do with the data (e.g. add to in-transit report).

DevOps to investigate what data elements are available for us to pull back.
Analytics to work with DevOps on structure and variables for storing the data and adding to data dictionary.

[amber-emmes]

It looks like the specific package tracking API call will need:

• Customer transaction ID
• Authorization token
• Tracking number

Optional additional parameters like a carrier code, FedEx-provided trackingNumberUniqueId (distinct from tracking ID, evidently), or specific ship date range to look in can help make the search more performant as well.

The results will be an array of packages, each of which will have a tracking number and a fair amount of specific tracking details. There is enough data here that I think to iterate every possible item would defeat the point of a summary, but of likely desirable pieces of information, it offers:

• Tracking Number
• trackingNumberUniqueId
• Carrier code
• If the shipment has associated other shipments
• Shipment notes
• Shipment nickname
• Return information for return shipments (not sure if our return shipping for home kits would be processed through this workflow)
• Latest status details, including reasons for delay or customer actions needed
• Special handling information
• An array of date and times including things like estimated delivery time, actual delivery time, and ship
• Estimated delivery time window
• Standard transit time window
• Available notifications
• Alerts

If there's anything not in this list that you'd like to see if they have, please let me know. If there's anything you want me to zero in on or answer specific questions about, please also let me know.

Awaiting further information on what next steps should be taken regarding this ticket.

[erincschwartz]

@Davinkjohnson Are Customer transaction ID and Authorization token related to the API call that could be created/automatically entered by our team or would these need to come from BPTL?

Making note here as we move forward, the following information would be helpful:
Latest status details, including reasons for delay or customer actions needed
Estimated delivery time window
An array of date and times including things like estimated delivery time, actual delivery time, and ship

@amber-emmes Did you happen to see an example of "Alerts" in your research? Are there descriptions of these items somewhere?

[amber-emmes]

@erincschwartz This was the example given in the documentation:

alerts	Array of objectsThe cxs alert type, alert code and alert messageExample: TRACKING.DATA.NOTFOUND - Tracking data unavailable
Array codestringSpecifies the api alert code.alertTypestringEnum: "NOTE" "WARNING"Specifies the api alert type.messagestringSpecifies the api alert message.	code
code	stringSpecifies the api alert code.
alertType	stringEnum: "NOTE" "WARNING"Specifies the api alert type.
message	stringSpecifies the api alert message.

The documentation is somewhat obtuse, but may be viewed here by scrolling down to the "responses" section and viewing the 200 response. I do not know a great deal else about it.

[Davinkjohnson]

Pending a sync with the CGR team. We need to align our work closer to when they'll also do this.