Fenix Tracking (API or Webhook) Payloads and Field-Level Description
- Srinivas Aluri
This page provides a detailed description of the tracking payload, including comprehensive explanations of each field's purpose and usage
Ignore fields marked with strikethrough that are no longer being used.
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. |
Field Name | Description | |
|---|---|---|
| 1 | day | Day of the activity |
| 2 | time | Time of the activity |
| 3 | offset | Offset of the activity
|
| 4 | desc | Description of the activity
|
| 5 | event_code | Event code of the activity
|
| 6 | fenix_code | Fenix code for the activity
|
| 7 | address | Address of the activity |
Field Name | Description | |
|---|---|---|
| 1 | first_name | Â |
| 2 | last_name | Â |
| 3 | name | Â |
| 4 | company | Â |
| 5 | address1 | Â |
| 6 | address2 | Â |
| 7 | country | Country name
|
| 8 | country_code | Country code
|
| 9 | province | Province name
|
| 10 | province_code | province code
|
| 11 | city | City name
|
| 12 | zip_code | zipcode
|
| 13 | latitude | Â |
| 14 | longitude | Â |
| 15 | zipcode_populate_code | Â |
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 |
| 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
} |
| 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
|
| 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"
} |
| 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
} |
| 11 | shipment_info | It contains the information regarding |
| 12 | pickup_info | It contains the information regarding the |
| 13 | intransit_info | It contains the information regarding the |
| 14 | return_to_sender_info | It contains the information regarding the |
| 15 | shipment_cancelled_info | It contains the information regarding the |
| 16 | delivery_info | It contains the information regarding the
|
| 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 |
| 18 | tracking_job_process_dttm | It contains the information about the datetime of the last processing.
|
| 19 | stalled_shipment_days | Â |
| 20 | return_to_sender | It is a boolean value that is |
| 21 | predicated_accuracy | Â |
| 22 | intial_fenix_expected_delivery_dates | Â |
| 23 | updated_fenix_expected_delivery_dates | Â |
| 24 | predicted_fenix_expected_delivery_date_on_pickup | Â |
Field Name | Description | |
|---|---|---|
| 1 | code | Carrier service code
|
| 2 | name | Actual carrier service name
|
| 3 | short_code | Carrier service short code
|
| 4 | operating_company | Â |
Field Name | Description | |
|---|---|---|
| 1 | package_weight | It contains the information regarding package weight along with units. |
| 2 | package_dimension | It contains the information regarding package dimensions along with units. |
| 3 | package_dimensional_weight | Â |
| 4 | shipment_weight | Â |
| 5 | package_type | Type of the package
|
Field Name | Description | |
|---|---|---|
| 1 | initial_expected_delivery_dttm | It contains information about initial carrier expected delivery date.
|
| 2 | updated_expected_delivery_dttm | It contains information about initial carrier expected delivery date.
|
| 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. |
| 4 | recent_shipment_exception | It contains information about the most recent shipment exception. |
| 5 | shipment_exceptions | It includes a list of the shipment exceptions, ranging from the initial to the most recently exception |
| 6 | out_for_delivery_info | It contains information about the |
| 7 | recent_delivery_exception | It contains information about the most recent delivery exception. |
| 8 | initial_delivery_exception | It contains information about the most initial delivery exception. |
| 9 | delivery_exceptions | It includes a list of the delivery exceptions, ranging from the initial to the most recently delivery exception |
| 10 | delivered_info | It contains information about the |
| 11 | returned_to_sender_info | It contains information about the |
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.
|
| 3 | event_description | Carrier event description |
| 4 | event_code | Carrier event code |
| 5 | mapped_track_event | Â |
Field Name | Description | |
|---|---|---|
| 1 | address | It contains the address where the exception events occurred. |
| 2 |
| It contains information about when exception events occurred.
|
| 3 | event_description | Exception event description
|
| 4 | event_code | Exception event code
|
| 5 | exception_reason | Exception reason
|
| 6 | mapped_track_event | Â |
Field Name | Description | |
|---|---|---|
| 1 |
| The number of times the shipment has been processed by the Fenix tracking job. |
| 2 |
| The delivery status of the shipment after it has been processed by the Fenix tracking job. |