---
updatedAt: 2026-03-12T15:40:52.000Z
agentTools:
  projectIndex: https://developers.shipup.co/llms.txt
---

# Tracker

## Example payload

```json
{
    "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

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        FIELD
      </th>

      <th>
        DESCRIPTION
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **custom_variables**
        object
      </td>

      <td>
        Object containing custom variables. Those variables can be reused to customize or add logic in the notifications
      </td>
    </tr>

    <tr>
      <td>
        **delivered_at**  
        datetime
      </td>

      <td>
        Time at which the tracker was delivered
      </td>
    </tr>

    <tr>
      <td>
        **displayable_expected_delivery_date**  
        string, format is yyyy-mm-dd
      </td>

      <td>
        Displayable expected delivery date for the package. See [Expected deliveries](https://developers.shipup.co/reference/expected-deliveries)
      </td>
    </tr>

    <tr>
      <td>
        **displayable_expected_delivery_datetime**  
        datetime
      </td>

      <td>
        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
      </td>
    </tr>

    <tr>
      <td>
        **delivery_status_code**  
        string
      </td>

      <td>
        Code uniquely identifying a shipping carrier. See [available values](https://developers.shipup.co/reference/delivery-statuses)
      </td>
    </tr>

    <tr>
      <td>
        **first_delivery_attempted_at**  
        datetime
      </td>

      <td>
        Time at which the first carrier presentation was made, or time at which the package first reached a pickup point
      </td>
    </tr>

    <tr>
      <td>
        **mute_notifications**  
        boolean
      </td>

      <td>
        If set to <code>true</code>, no notification will be sent for this tracker. Defaults to <code>false</code>
      </td>
    </tr>

    <tr>
      <td>
        **shipped_at**  
        datetime
      </td>

      <td>
        Time at which the tracker was shipped by the carrier
      </td>
    </tr>

    <tr>
      <td>
        **tracking_link**  
        string
      </td>

      <td>
        Shipup generated URL redirecting to the delivery tracking on the shipping carrier's website
      </td>
    </tr>

    <tr>
      <td>
        **tracking_number**  
        string
      </td>

      <td>
        Package tracking number
      </td>
    </tr>

    <tr>
      <td>
        **carrier_tracker_identifier**  
        string
      </td>

      <td>
        Internal tracking number for carriers that require it
      </td>
    </tr>

    <tr>
      <td>
        **untracked_carrier_name**  
        string
      </td>

      <td>
        Carrier name to be displayed as a fallback if Shipup can't find a matching carrier
      </td>
    </tr>

    <tr>
      <td>
        **untracked_carrier_url**  
        string
      </td>

      <td>
        Carrier tracking URL to be displayed as a fallback if Shipup can't find a matching carrier
      </td>
    </tr>

    <tr>
      <td>
        **uuid**  
        string
      </td>

      <td>
        Unique identifier for the object, UUID format.
      </td>
    </tr>

    <tr>
      <td>
        **created_at**  
        datetime
      </td>

      <td>
        Time at which the tracker was imported into Shipup
      </td>
    </tr>

    <tr>
      <td>
        **updated_at**  
        datetime
      </td>

      <td>
        Time at which the tracker was last updated
      </td>
    </tr>
  </tbody>
</Table>

## Expandable resources

* [Fulfillment](https://developers.shipup.co/reference/fulfillment-api-resource)
* [Events](https://developers.shipup.co/reference/event-api-resource)
* [Notifications](https://developers.shipup.co/reference/notification-api-resource)
* [Line items](https://developers.shipup.co/reference/line-item-api-resource)
* [Carrier](https://developers.shipup.co/reference/carrier-api-resource)
* [Carrier service](https://developers.shipup.co/reference/carrier-service-api-resource)
* [Details](https://developers.shipup.co/reference/tracker-details)