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.

FIELD

DESCRIPTION

carrier_code string, optional

Code uniquely identifying a shipping carrier. See available values

carrier_service_code
string, optional

Code uniquely identifying a shipping carrier's service. See available values

custom_variables
object, optional

Object containing custom variables. Those variables can be reused to customize or add logic in the notifications

expected_delivery_at
datetime, optional

Expected delivery time for the package

If provided, this date will be used as the merchant expected delivery. Read more in the Expected delivery subsection

line_items
array of objects, optional

Line item shipped in this tracker.
See line Item payload above

mute_notifications
boolean, optional

If set to true, no notification will be generated for this tracker.
Defaults to false

tracking_number
string, required

Package tracking number

untracked_carrier_name
string, optional

Carrier name to be displayed as a fallback if Shipup can't find a matching carrier

untracked_carrier_url
string, optional

Carrier tracking URL to be displayed as a fallback if Shipup can't find a matching carrier

Carrier codes

Shipup will be adding carrier support overtime. You can read the carriers list 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.