{
"object": "tracker",
"id": 830297390,
"carrier_code": "dpd_fr",
"custom_variables": {},
"delivered_at": 1530183480,
"displayable_expected_delivery_date": "2018-06-28",
"displayable_expected_delivery_datetime": 1530208800,
"delivery_status_code": "delivered",
"first_delivery_attempted_at": 1530183480,
"mute_notifications": false,
"shipped_at": 1529595900,
"tracking_link": "http://www.dpd.fr/traces_250059116919212260",
"tracking_number": "250059116919212260",
"untracked_carrier_name": "DPD France",
"untracked_carrier_url": "http://www.dpd.fr/traces_250059116919212260",
"uuid": "6ac199f1-e1f7-41c0-b26a-a409a31e51f2",
"created_at": 1529600912,
"updated_at": 1529751762,
"carrier": {
"object": "carrier",
"code": "dpd_fr",
"name": "DPD France"
},
"carrier_service": {
"object": "carrier_service",
"id": 12345,
"code": "colissimo_express",
"name": "Colissimo Express"
},
"events": null,
"fulfillment": null,
"notifications": null,
"line_items": null
}
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 |
---|---|
id | Unique identifier of the tracker |
carrier_code | Code uniquely identifying a shipping carrier. Read the below section for more details |
carrier_service_code | Code uniquely identifying a shipping carrier's delivery service. Should be used in association with the |
custom_variables | Object containing custom variables. Those variables can be reused to customize or add logic in the notifications |
delivered_at | Time at which the tracker was delivered |
displayable_expected_delivery_date | Displayable expected delivery date for the package. Shipup's data model includes different kinds of expected delivery dates (e.g. |
displayable_expected_delivery_datetime | Displayable expected delivery date and time for the package. The time precision might not always be available, so prefer using the more robust |
delivery_status_code | Code uniquely identifying a shipping carrier |
expected_delivery_at | Value provided by the merchant. This value represents the expected delivery date and time known by the merchant. This information makes sense at the tracker creation before the carrier starts handling the tracker. |
first_delivery_attempted_at | Time at which the first carrier presentation was made, or time at which the package first reached a pickup point |
mute_notifications | If set to |
shipped_at | Time at which the tracker was shipped by the carrier |
tracking_link | Shipup generated URL redirecting to the delivery tracking on the shipping carrier's website |
tracking_number | Package tracking number |
untracked_carrier_name | Carrier name to be displayed as a fallback if Shipup can't find a matching carrier |
untracked_carrier_url | Carrier tracking URL to be displayed as a fallback if Shipup can't find a matching carrier |
uuid | Unique identifier for the object, UUID format. |
carrier | Carrier for this tracker. Object keys are: |
events | List of shipping events for this tracker |
fulfillment | Fulfillment this tracker is part of |
line_items | List of items shipped in this tracker |
notifications | List of notifications sent for this tracker |
created_at | Time at which the tracker was imported into Shipup |
updated_at | Time at which the tracker was last updated |
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.