mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-09 12:47:46 +00:00
17 lines
5.0 KiB
Markdown
17 lines
5.0 KiB
Markdown
# TrackingStatus
|
|
|
|
The latest tracking information of this shipment.
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
| `location` | [components.TrackingStatusLocationBase](../../models/components/trackingstatuslocationbase.md) | :heavy_check_mark: | An object containing zip, city, state and country information of the tracking event. | |
|
|
| `object_created` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | |
|
|
| `object_id` | *str* | :heavy_check_mark: | N/A | |
|
|
| `object_updated` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | |
|
|
| `status` | [components.TrackingStatusStatus](../../models/components/trackingstatusstatus.md) | :heavy_check_mark: | Indicates the high level status of the shipment. | DELIVERED |
|
|
| `status_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Date and time when the carrier scanned this tracking event. This is displayed in UTC. | 2016-07-23T00:00:00Z |
|
|
| `status_details` | *str* | :heavy_check_mark: | The human-readable description of the status. | Your shipment has been delivered at the destination mailbox. |
|
|
| `substatus` | [Optional[components.TrackingStatusSubstatus]](../../models/components/trackingstatussubstatus.md) | :heavy_minus_sign: | A finer-grained classification of the tracking event. | | |