Files
speakeasy-playground/docs/models/components/track.md
Mike Lueders 14c449163c generate sdk
2024-03-01 12:52:50 -06:00

13 KiB
Raw Blame History

Track

Fields

Field Type Required Description Example
address_from components.TrackingStatusLocationBase ✔️ The sender address with city, state, zip and country information.
carrier str ✔️ Name of the carrier of the shipment to track. See Carriers. usps
messages List[str] ✔️ N/A
servicelevel components.ServiceLevel ✔️ Contains details regarding the service level for the given rate.
tracking_history List[components.TrackingStatus] ✔️ A list of tracking events, following the same structure as tracking_status.
It contains a full history of all tracking statuses, starting with the earlier tracking event first.
tracking_number str ✔️ Tracking number to track. 9205590164917312751089
address_to Optional[components.TrackingStatusLocationBase] The recipient address with city, state, zip and country information.
eta date The estimated time of arrival according to the carrier, this might be updated by carriers during the life of the shipment.
metadata Optional[str] A string of up to 100 characters that can be filled with any additional information you want to attach to the object. Order 000123
original_eta date The estimated time of arrival according to the carrier at the time the shipment first entered the system. 2021-07-23T00:00:00Z
tracking_status Optional[components.TrackingStatus] The latest tracking information of this shipment.
transaction Optional[str] The object_id of the transaction associated with this tracking object.
This field is visible only to the object owner of the transaction.