---
updatedAt: 2025-12-09T09:17:52.000Z
agentTools:
  projectIndex: https://developers.shipup.co/llms.txt
---

# The tracker object

A `tracker` represents a shipment handled by a shipping carrier. It must contain a tracking number and is generally generated when the shipping label is received from the carrier.

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

      <th style={{ textAlign: "left" }}>
        DESCRIPTION
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        **carrier_code**
        string, optional
      </td>

      <td style={{ textAlign: "left" }}>
        Code uniquely identifying a shipping carrier. See [available values](https://developers.shipup.co/reference/carrier-services-codes)
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **carrier_service_code**  
        string, optional
      </td>

      <td style={{ textAlign: "left" }}>
        Code uniquely identifying a shipping carrier's service. See [available values](https://developers.shipup.co/reference/carrier-services-codes)
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **custom_variables**  
        object, optional
      </td>

      <td style={{ textAlign: "left" }}>
        Object containing custom variables. Those variables can be reused to customize or add logic in the notifications
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **expected_delivery_at**  
        datetime, optional
      </td>

      <td style={{ textAlign: "left" }}>
        Expected delivery time for the package

        If provided, this date will be used as the `merchant` expected delivery. Read more in the [Expected delivery](https://developers.shipup.co/reference/sending-expected-deliveries) subsection
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **line_items**  
        array of objects, optional
      </td>

      <td style={{ textAlign: "left" }}>
        Line item shipped in this tracker.  
        See line Item payload above
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **mute_notifications**  
        boolean, optional
      </td>

      <td style={{ textAlign: "left" }}>
        If set to `true`, no notification will be generated for this tracker.  
        Defaults to `false`
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **tracking_number**  
        string, required
      </td>

      <td style={{ textAlign: "left" }}>
        Package tracking number
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **untracked_carrier_name**  
        string, optional
      </td>

      <td style={{ textAlign: "left" }}>
        Carrier name to be displayed as a fallback if Shipup can't find a matching carrier
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **untracked_carrier_url**  
        string, optional
      </td>

      <td style={{ textAlign: "left" }}>
        Carrier tracking URL to be displayed as a fallback if Shipup can't find a matching carrier
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **pickup_point_merchant_id**  
        string, optional
      </td>

      <td style={{ textAlign: "left" }}>
        The reference to the store uploaded in Shipup, only valid if the carrier code is `in_store_collection`.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **pickup_code**  
        string, optional
      </td>

      <td style={{ textAlign: "left" }}>
        The pickup code the customer should provide for his delivery, only valid if the carrier code is `in_store_collection`.
      </td>
    </tr>
  </tbody>
</Table>

**Carrier codes**

Shipup will be adding carrier support over time. You can read the [carriers list](https://developers.shipup.co/reference/carrier-services-codes) to view those already available.\
Shipup provides a carrier detection feature to automatically detect carriers depending on the tracking number. However, some carriers share tracking number patterns and the detection is thus error-prone. If you've correctly added the carriers used by your company to send your packages on the Setting Page, chances are that our algorithm will work. You can and should also manually provide a `carrier_code` in your requests to avoid any mistake.