Fenix Tracking (API or Webhook) Payloads and Field-Level Description

This page provides a detailed description of the tracking payload, including comprehensive explanations of each field's purpose and usage

https://fenixcommerce.atlassian.net/wiki/spaces/FFL/pages/1917026338

Ignore fields marked with strikethrough that are no longer being used.

	Field Name	Description

	Field Name	Description
1	id	Unique ID of the shipment
2	activities	It contains information about all tracking events, including the event location and date of occurrence Refer to activity object for details
3	tracking_summary	It contains information about specific required tracking events, including the event location, date of occurrence, and details about the package and service. Refer trackingsummary object for details
4	shipper_address	It contains information about the shipping address of the package. Refer address object for details

Activity Object

The activity object contains the following fields:

{
    "day": "Jun 03, 2024", 
    "time": "12:00 AM", 
    "desc": "Picked up", 
    "address": {
        "country": "United States", 
        "country_code": "US", 
        "province": null, 
        "province_code": "IN", 
        "city": "ZIONSVILLE", 
        "zip_code": "46077"
    }, 
    "offset": "-04:00", 
    "event_code": "PU", 
    "fenix_code": null
}

	Field Name	Description

	Field Name	Description
1	day	Day of the activity `Ex. Jun 03, 2024`
2	time	Time of the activity `Ex. 12:00 AM`
3	offset	Offset of the activity `Ex. -04:00`
4	desc	Description of the activity `Ex. Departed FedEx location`
5	event_code	Event code of the activity `Ex. IT`
6	fenix_code	Fenix code for the activity `Ex. IT`
7	address	Address of the activity Refer to address object for details

Address Object

The address object contains the following fields:

{
    "country": "United States", 
    "country_code": "US", 
    "province": null, 
    "province_code": "IN", 
    "city": "ZIONSVILLE", 
    "zip_code": "46077"
}

	Field Name	Description

	Field Name	Description
1	first_name
2	last_name
3	name
4	company
5	address1
6	address2
7	country	Country name `Ex. United States`
8	country_code	Country code `Ex. US`
9	province	Province name `Ex. Indiana`
10	province_code	province code `Ex. IN`
11	city	City name `Ex. ZIONSVILLE`
12	zip_code	zipcode `Ex. 46077`
13	latitude
14	longitude
15	zipcode_populate_code

TrackingSummary Object

The trackingsummaries object contains the following fields:

	Field Name	Description

	Field Name	Description
1	carrier_code	Shipped carrier code populated by the Fenix
2	carrier_name	Shipped carrier name populated by the Fenix
3	tracking_company	Tracking Company provided as part of the Shopify data
4	tracking_number	Actual carrier tracking number
5	delivery_status	Shipment Delivery Status SHIPMENT_CONFIRMED READY_TO_SHIP SHIPMENT_CANCELLED PICKED_UP_BY_CARRIER INTRANSIT SHIPMENT_EXCEPTION OUT_FOR_DELIVERY DELIVERY_EXCEPTION RETURN_TO_SENDER RETURNED_TO_SENDER DELIVERED
6	service_info	It holds the actual carrier service level info `{ "code": "GROUND_HOME_DELIVERY", "name": "FedEx Home Delivery", "short_code": "HD", "operating_company": null }` Refer to ServiceInfo object for details
7	hybrid_at_service	It retains information on whether shipped services are hybrid and if the last mile delivery is handled by a USPS carrier or not `Ex. FedEx Smartpost, UPS Surepost, etc...`
8	hybrid_at_event
9	shipment_package	It stores information about the shipped package, including dimensions and weight. `{ "package_weight": { "value": 40.1, "units": "LB" }, "package_dimension": { "units": "IN", "length": 25, "width": 15, "height": 13 }, "package_dimensional_weight": null, "shipment_weight": null, "package_type": "YOUR_PACKAGING" }` Refer to ShipmentPackage object for details
10	last_updated_info	It holds the latest update track information regarding the package. `{ "address": { "country": "United States", "country_code": "US", "province": null, "province_code": "TN", "city": "Clarksville", "zip_code": "37042" }, "date_time": { "day": "Thursday", "actual_dttm": "2024-06-06T13:06:00-05:00", "formatted_dttm": "2024-06-06T14:06:00-04:00" }, "event_description": "Delivered", "event_code": "DL", "mapped_track_event": false }` Refer to TransitEventInfo object for details
11	shipment_info	It contains the information regarding `warehouse labelprint`event. `{ "address": { "country": "United States", "country_code": "US", "province": null, "province_code": null, "city": null, "zip_code": "46075" }, "date_time": { "day": "Monday", "actual_dttm": "2024-06-03T08:36:00-04:00", "formatted_dttm": "2024-06-03T08:36:00-04:00" }, "event_description": "Shipment information sent to FedEx", "event_code": "IN", "mapped_track_event": true }` Refer to TransitEventInfo object for details
12	pickup_info	It contains the information regarding the `carrier pickup`event. `{ "address": { "country": "United States", "country_code": "US", "province": null, "province_code": "IN", "city": "ZIONSVILLE", "zip_code": "46077" }, "date_time": { "day": "Monday", "actual_dttm": "2024-06-03T00:00:00-04:00", "formatted_dttm": "2024-06-03T00:00:00-04:00" }, "event_description": "Picked up", "event_code": "PU", "mapped_track_event": true }` Refer to TransitEventInfo object for details
13	intransit_info	It contains the information regarding the `package intransit`event. `{ "address": { "country": "United States", "country_code": "US", "province": null, "province_code": "TN", "city": "CLARKSVILLE", "zip_code": "37040" }, "date_time": { "day": "Tuesday", "actual_dttm": "2024-06-04T06:50:00-05:00", "formatted_dttm": "2024-06-04T07:50:00-04:00" }, "event_description": "At local FedEx facility", "event_code": "IT", "mapped_track_event": false }` Refer to TransitEventInfo object for details
14	return_to_sender_info	It contains the information regarding the `package return to sender` event. `{ "address": { "country": "United States", "country_code": "US", "province": null, "province_code": "IN", "city": "ZIONSVILLE", "zip_code": "46077" }, "date_time": { "day": "Monday", "actual_dttm": "2024-06-03T00:00:00-04:00", "formatted_dttm": "2024-06-03T00:00:00-04:00" }, "event_description": "Picked up", "event_code": "PU", "mapped_track_event": true }` Refer to TransitEventInfo object for details
15	shipment_cancelled_info	It contains the information regarding the `shipment concellation`event. `{ "address": { "country": "United States", "country_code": "US", "province": null, "province_code": "IN", "city": "ZIONSVILLE", "zip_code": "46077" }, "date_time": { "day": "Monday", "actual_dttm": "2024-06-03T00:00:00-04:00", "formatted_dttm": "2024-06-03T00:00:00-04:00" }, "event_description": "Picked up", "event_code": "PU", "mapped_track_event": true }` Refer to TransitEventInfo object for details
16	delivery_info	It contains the information regarding the `below` Initial Carrier Excepted and Updated Expected Delivery Dates Shipment Exception Events Out For Delivered Event Delivery Exception Events Delivered Event Returned To Sender Event Refer to deliveryInfo object for details
17	tracked_status_list	It contains information about how many times this shipment has been processed by the Fenix tracking job, along with the status of the package after each process Refer to TrackedStatusList object for details
18	tracking_job_process_dttm	It contains the information about the datetime of the last processing. `Ex. 2024-06-06T14:25:14.979351-04:00`
19	stalled_shipment_days
20	return_to_sender	It is a boolean value that is `TRUE` only when the package has been returned to the sender.
21	predicated_accuracy
22	intial_fenix_expected_delivery_dates
23	updated_fenix_expected_delivery_dates
24	predicted_fenix_expected_delivery_date_on_pickup

ServiceInfo Object

It contains the following fields:

{
    "code": "GROUND_HOME_DELIVERY", 
    "name": "FedEx Home Delivery", 
    "short_code": "HD", 
    "operating_company": null
}

	Field Name	Description

	Field Name	Description
1	code	Carrier service code `Ex. GROUND_HOME_DELIVERY`
2	name	Actual carrier service name `Ex. FedEx Home Delivery`
3	short_code	Carrier service short code `Ex. HD`
4	operating_company

ShipmentPackage Object

The shipmentpackage object contains the following fields:

	Field Name	Description

	Field Name	Description
1	package_weight	It contains the information regarding package weight along with units. `{ "value": 40.1, "units": "LB" }`
2	package_dimension	It contains the information regarding package dimensions along with units. `{ "units": "IN", "length": 25, "width": 15, "height": 13 }`
3	package_dimensional_weight
4	shipment_weight
5	package_type	Type of the package `Ex. YOUR_PACKAGING`

DeliveryInfo Object:

It contains the following fields

https://fenixcommerce.atlassian.net/wiki/spaces/FFL/pages/1917353985

	Field Name	Description

	Field Name	Description
1	initial_expected_delivery_dttm	It contains information about initial carrier expected delivery date. `{ "day": "Tuesday", "actual_dttm": "2024-06-04T00:00:00-06:00", "formatted_dttm": "2024-06-04T01:00:00-05:00" }` `actual_datetime` refers to the carrier-provided datetime. `formatted_datetime` is the datetime converted to `EST` zone by the Fenix platform. `day` is calculated by Fenix based on `formatted_datetime`
2	updated_expected_delivery_dttm	It contains information about initial carrier expected delivery date. `{ "day": "Thursday", "actual_dttm": "2024-06-06T00:00:00-06:00", "formatted_dttm": "2024-06-06T01:00:00-05:00" }` `actual_datetime` refers to the carrier-provided datetime. `formatted_datetime` is the datetime converted to `EST` zone by the Fenix platform. `day` is calculated by Fenix based on `formatted_datetime`
3	carrier_edd_infos	It includes a list of the carrier's expected delivery dates, from the initial expected date to the most recent updates, along with the delivery status and processing time. `[{ "edd": { "day": "Tuesday", "actual_dttm": "2024-06-04T00:00:00-06:00", "formatted_dttm": "2024-06-04T01:00:00-05:00" }, "event_type": "PICKED_UP_BY_CARRIER", "processed_dttm": "2024-06-03T20:43:31.254388-05:00" }]`
4	recent_shipment_exception	It contains information about the most recent shipment exception. Refer to ExceptionEventInfo object for details
5	shipment_exceptions	It includes a list of the shipment exceptions, ranging from the initial to the most recently exception Refer to ExceptionEventInfo object for details
6	out_for_delivery_info	It contains information about the `OutForDelivey` event `{ "address": { "country": "United States", "country_code": "US", "province": null, "province_code": "TN", "city": "CLARKSVILLE", "zip_code": "37040" }, "date_time": { "day": "Tuesday", "actual_dttm": "2024-06-04T06:59:00-05:00", "formatted_dttm": "2024-06-04T07:59:00-04:00" }, "event_description": "On FedEx vehicle for delivery", "event_code": "IT", "mapped_track_event": false }` Refer to TransitEventInfo object for details
7	recent_delivery_exception	It contains information about the most recent delivery exception. Refer to ExceptionEventInfo object for details
8	initial_delivery_exception	It contains information about the most initial delivery exception. Refer to ExceptionEventInfo object for details
9	delivery_exceptions	It includes a list of the delivery exceptions, ranging from the initial to the most recently delivery exception Refer to ExceptionEventInfo object for details
10	delivered_info	It contains information about the `Delivered` event `{ "address": { "country": "United States", "country_code": "US", "province": null, "province_code": "TN", "city": "Clarksville", "zip_code": "37042" }, "date_time": { "day": "Thursday", "actual_dttm": "2024-06-06T13:06:00-05:00", "formatted_dttm": "2024-06-06T14:06:00-04:00" }, "event_description": "Delivered", "event_code": "DL", "mapped_track_event": false }` Refer to TransitEventInfo object for details
11	returned_to_sender_info	It contains information about the `Returned TO Sender` event Refer to TransitEventInfo object for details

TransitEventInfo Object

The transitEventInfo object contains the following fields:

{
    "address": {
        "country": "United States", 
        "country_code": "US", 
        "province": null, 
        "province_code": "IN", 
        "city": "ZIONSVILLE", 
        "zip_code": "46077"
    }, 
    "date_time": {
        "day": "Monday", 
        "actual_dttm": "2024-06-03T00:00:00-04:00", 
        "formatted_dttm": "2024-06-03T00:00:00-04:00"
    }, 
    "event_description": "Picked up", 
    "event_code": "PU", 
    "mapped_track_event": true
}

	Field Name	Description

	Field Name	Description
1	address	It contains the address where the specific event occurred.
2	date_time	It contains information about when specific events occurred. `actual_datetime` refers to the carrier-provided datetime. `formatted_datetime` is the datetime converted to `EST` zone by the Fenix platform. `day` is calculated by Fenix based on `formatted_datetime`
3	event_description	Carrier event description
4	event_code	Carrier event code
5	mapped_track_event

ExceptionEventInfo Object