Tracker

Example payload

{
    "object": "tracker",
    "id": 37371,
    "created_at": "2024-07-17T00:00:00Z",
    "custom_variables": null,
    "delivered_at": null,
    "delivery_status_code": "transit",
    "displayable_expected_delivery_date": "2024-07-22",
    "displayable_expected_delivery_datetime": null,
    "displayable_expected_delivery_kind": "promise",
    "displayable_expected_delivery_start_date": null,
    "displayable_expected_delivery_start_datetime": null,
    "displayable_expected_delivery_end_date": "2024-07-22",
    "displayable_expected_delivery_end_datetime": null,
    "first_delivery_attempted_at": null,
    "mute_notifications": false,
    "shipped_at": "2024-07-17T19:13:40Z",
    "tracking_link": "https://lasership.com/track.php?track_number_input=UJ1CM9T6YP0IWUB",
    "tracking_number": "UJ1CM9T6YP0IWUB",
    "carrier_tracker_identifier": null,
    "untracked_carrier_name": null,
    "untracked_carrier_url": null,
    "updated_at": "2024-07-17T16:13:40Z",
    "uuid": "8bb7fdf1-b714-429e-9bb9-84c360705d0c",
    "carrier": {
        "object": "carrier",
        "code": "lasership"
    },
    "carrier_service": {
        "object": "carrier_service",
        "id": 2367
    },
    "events": {
      "object": "list",
      "data": [
        {
          "object": "event",
          "id": 775
        }
      ]
    },
    "fulfillment": {
        "object": "fulfillment",
        "id": 42916
    },
    "line_items": {
        "object": "list",
        "data": [
            {
                "object": "line_item",
                "id": 8793
            }
        ]
    },
    "notifications": {
        "object": "list",
        "data": [
            {
                "object": "notification",
                "id": 34768
            }
        ]
    },
    "details": {
      	"object": "tracker_details",
      	"id": 134
    }
}

Attributes

FIELD	DESCRIPTION
custom_variables object	Object containing custom variables. Those variables can be reused to customize or add logic in the notifications
delivered_at datetime	Time at which the tracker was delivered
displayable_expected_delivery_date string, format is yyyy-mm-dd	Displayable expected delivery date for the package. See Expected deliveries
displayable_expected_delivery_datetime datetime	Displayable expected delivery date and time for the package. The time precision might not always be available, so prefer using the more robust `displayable_expected_delivery_date` attribute
delivery_status_code string	Code uniquely identifying a shipping carrier. See available values
first_delivery_attempted_at datetime	Time at which the first carrier presentation was made, or time at which the package first reached a pickup point
mute_notifications boolean	If set to `true`, no notification will be sent for this tracker. Defaults to `false`
shipped_at datetime	Time at which the tracker was shipped by the carrier
tracking_link string	Shipup generated URL redirecting to the delivery tracking on the shipping carrier's website
tracking_number string	Package tracking number
carrier_tracker_identifier string	Internal tracking number for carriers that require it
untracked_carrier_name string	Carrier name to be displayed as a fallback if Shipup can't find a matching carrier
untracked_carrier_url string	Carrier tracking URL to be displayed as a fallback if Shipup can't find a matching carrier
uuid string	Unique identifier for the object, UUID format.
created_at datetime	Time at which the tracker was imported into Shipup
updated_at datetime	Time at which the tracker was last updated

Expandable resources