Trackers
Tracker Detail Model
Properties
- Name
carrier- Type
- [Carrier](#schemacarrier)
- Restrictions
- Description
- Name
carrier_service- Type
- [CarrierResource](#schemacarrierresource)
- Restrictions
- Description
- Name
origin_location- Type
- [TrackerLocation](#schematrackerlocation)
- Restrictions
- Description
- Name
destination_location- Type
- [TrackerLocation](#schematrackerlocation)
- Restrictions
- Description
- Name
shipped_date- Type
- string,null(date-time)
- Restrictions
- Description
- Name
estimated_delivery_date- Type
- string,null(date-time)
- Restrictions
- Description
- Name
actual_delivery_date- Type
- string,null(date-time)
- Restrictions
- Description
- Name
guaranteed_delivery_date- Type
- string,null(date-time)
- Restrictions
- Description
{
"carrier": {
"id": "string",
"name": "string",
"handle": "string",
"services": [
null
],
"predefined_packages": [
{
"id": "pkg_2iHViqpO8v81j2e1nrpWkRuVfmo",
"name": "Tube",
"handle": "tube",
"description": "Triangular tube for rolled papers"
}
],
"account_fields": [
{
"name": "FedEx Cross Border Origin Hub",
"key": "origin_hub",
"type": "option",
"optional": false,
"option_values": [
"Fontana"
]
}
],
"accounts": [
{
"id": "string",
"name": "UPS Main Account",
"description": "The main account for shipping all non-hazmat packages.",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
},
"carrier_service": {
"id": "car_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "UPS",
"handle": "ups",
"description": "United Parcel Service"
},
"origin_location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
},
"destination_location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
},
"shipped_date": "2019-08-24T14:15:22Z",
"estimated_delivery_date": "2019-08-24T14:15:22Z",
"actual_delivery_date": "2019-08-24T14:15:22Z",
"guaranteed_delivery_date": "2019-08-24T14:15:22Z"
}
Tracker Location Model
Properties
- Name
id- Type
- string
- Restrictions
- Description
The ID of the location for the tracker
- Name
name- Type
- string,null
- Restrictions
- Description
The name for the location if provided
- Name
city- Type
- string,null
- Restrictions
- Description
- Name
province- Type
- string,null
- Restrictions
- Description
- Name
post_code- Type
- string,null
- Restrictions
- Description
- Name
country_code- Type
- string,null
- Restrictions
- Description
- Name
latitude- Type
- number,null
- Restrictions
- Description
- Name
longitude- Type
- number,null
- Restrictions
- Description
{
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
}
Tracker Event Model
Properties
- Name
id- Type
- string
- Restrictions
- Description
- Name
status- Type
- string
- Restrictions
- Description
- Name
message- Type
- string,null
- Restrictions
- Description
- Name
timestamp- Type
- string,null(date-time)
- Restrictions
- Description
- Name
source- Type
- string
- Restrictions
- Description
- Name
additional_data- Type
- string,null
- Restrictions
- Description
- Name
is_internal- Type
- boolean,null
- Restrictions
- Description
- Name
location- Type
- [TrackerLocation](#schematrackerlocation)
- Restrictions
- Description
{
"id": "te_2PcNWI9Fb82GvM2ijZ5xy8TRKLa",
"status": "pre_transit",
"message": "string",
"timestamp": "2019-08-24T14:15:22Z",
"source": "carrier",
"additional_data": "string",
"is_internal": true,
"location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
}
}
Tracker Model
Properties
- Name
id- Type
- string
- Restrictions
- Description
A unique identifier for the tracker.
- Name
status- Type
- string,null
- Restrictions
- Description
The current status of the tracked shipment.
- Name
tracking_code- Type
- string,null
- Restrictions
- Description
The carrier-provided tracking code for the shipment(s).
- Name
tracking_url- Type
- string,null
- Restrictions
- Description
If available, a URL where the latest tracking status can be viewed.
- Name
shipments- Type
- array,null
- Restrictions
- Description
- Name
details- Type
- [TrackerDetail](#schematrackerdetail)
- Restrictions
- Description
The details for a given tracker object.
- Name
events- Type
- [[TrackerEvent](#schematrackerevent)]
- Restrictions
- Description
[An event that has occured during the lifetime of the specified tracker.]
- Name
created_at- Type
- string(date-time)
- Restrictions
- Description
- Name
updated_at- Type
- string(date-time)
- Restrictions
- Description
{
"id": "string",
"status": "pre_transit",
"tracking_code": "9461200104262208438927",
"tracking_url": "https://track.easypost.com/djE6dHJrX2NiMzg2NjU2OGQ4NDRhYzU4M2E2ODgyYTU1ODBhZmJj",
"shipments": [
{
"id": "shp_0ujzPyRiIAffKhBux4PvQdDqMHY",
"addresses": {
"destination": {
"address": "[Object]",
"contact": "[Object]",
"display_name": "Work",
"metadata": "[Object]",
"marketplaces": "[Object]",
"coordinates": "[Object]"
},
"origin": {
"address": "[Object]",
"contact": "[Object]",
"display_name": "Work",
"metadata": "[Object]",
"marketplaces": "[Object]",
"coordinates": "[Object]"
},
"return": {
"address": "[Object]",
"contact": "[Object]",
"display_name": "Work",
"metadata": "[Object]",
"marketplaces": "[Object]",
"coordinates": "[Object]"
},
"location_configuration_id": "lc_2iFuzwcptRh9xt93ICDzK0vOszc"
},
"tax_identifiers": [
{
"taxable_entity_type": "sender",
"identifier_type": "ioss",
"value": "IM0123456789",
"issuing_country_code": "string"
}
],
"packages": [
{
"name": "string",
"geometry": {
"length": null,
"width": null,
"height": null,
"mass": null
},
"predefined_package_code": "string"
}
],
"customs": {
"contents_type": "merchandise",
"contents_description": "automobile parts",
"declarant": {
"name": "string",
"certify": true,
"date": null
},
"incoterm": "DDP",
"restriction_type": "other",
"restriction_description": "string",
"declaration_message": "string",
"items": null,
"identifiers": [
{
"entity_type": null,
"identifier_type": null,
"value": null,
"issuing_country_code": null
}
]
},
"options": {
"shipping": {
"access_code": "473281",
"commercial_address": false,
"currency_code": "USD",
"date": "2022-07-11T00:00:00.00Z",
"delivery_confirmation": false,
"dry_ice_mass": 2500,
"dropoff_type": "regular_pickup",
"handling_instructions": "Leave behind plant pot in front porch.",
"high_security": null,
"hold_for_pickup": false,
"invalid_address_handling": "forward_or_return",
"is_return": false,
"leave_safe": null,
"machinable": null,
"non_delivery": "return",
"restricted_substances": null,
"safe_place": "Garden Shed",
"saturday_delivery": false,
"signature_required": null,
"signature_type": "standard",
"tracked_service": null
},
"label": {
"format": "pdf",
"size": "4x6",
"custom_data": null
},
"insurance": {
"value": 55000,
"currency_code": "USD"
}
},
"carrier": {
"carrier_code": "string",
"service_code": "string",
"carrier_accounts": [
"string"
]
},
"name": "ORDER-273548",
"documents": [
{
"id": "doc_2iBgUNtezju7lmzmfOoJO8cnsVS",
"type": "label",
"file_name": "2iBgUMZPAyHoQlX2RnuaobI5yKk_label_0.png",
"file_type": "image/png",
"file_size": 129842,
"file_url": "https://envoy-shipment-files.s3.amazonaws.com/labels/2iBgUMZPAyHoQlX2RnuaobI5yKk_label_0.png?AWSAccessKeyId=AKIAY27LA84LC8DHB20X&Signature=kZY1RHl%2BBIClJ0UpjpKtAeqZqJA%3D&Expires=1725464510",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"rates": [
{
"id": "string",
"carrier": {
"id": "car_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "UPS",
"handle": "ups"
},
"carrier_service": {
"id": "cs_2iBgUNbKrgj7uVrsSiiF5ZhTelp",
"name": "Express",
"handle": "express"
},
"carrier_account": null,
"rate": 1650,
"currency_code": "USD",
"delivery_days": 3,
"ship_date": "2024-06-18T14:15:22Z",
"delivery_date": "2024-06-21T14:15:22Z",
"guaranteed_delivery_date": "2024-06-22T14:15:22Z"
}
],
"service": {
"rate": "rate_2iBgUKWHmQlBjYQyx9fAGMvcCEp",
"carrier": {
"id": "car_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "UPS",
"handle": "ups"
},
"carrier_service": {
"id": "cs_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "Express",
"handle": "express"
},
"carrier_account": {
"id": "ca_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "Main Account",
"handle": null
}
},
"status": "purchased",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"errors": [
{
"type": "rate_error",
"code": "rates_unavailable",
"source": "provider",
"message": "rates are not available for the provided shipment"
}
]
}
],
"details": {
"carrier": {
"id": "string",
"name": "string",
"handle": "string",
"services": [
null
],
"predefined_packages": [
{
"id": "pkg_2iHViqpO8v81j2e1nrpWkRuVfmo",
"name": "Tube",
"handle": "tube",
"description": "Triangular tube for rolled papers"
}
],
"account_fields": [
{
"name": "FedEx Cross Border Origin Hub",
"key": "origin_hub",
"type": "option",
"optional": false,
"option_values": null
}
],
"accounts": [
{
"id": "string",
"name": "UPS Main Account",
"description": "The main account for shipping all non-hazmat packages.",
"created_at": null,
"updated_at": null
}
]
},
"carrier_service": {
"id": "car_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "UPS",
"handle": "ups",
"description": "United Parcel Service"
},
"origin_location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
},
"destination_location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
},
"shipped_date": "2019-08-24T14:15:22Z",
"estimated_delivery_date": "2019-08-24T14:15:22Z",
"actual_delivery_date": "2019-08-24T14:15:22Z",
"guaranteed_delivery_date": "2019-08-24T14:15:22Z"
},
"events": [
{
"id": "te_2PcNWI9Fb82GvM2ijZ5xy8TRKLa",
"status": "pre_transit",
"message": "string",
"timestamp": "2019-08-24T14:15:22Z",
"source": "carrier",
"additional_data": "string",
"is_internal": true,
"location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
}
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
GET/trackers
List Trackers
List all trackers associated with a given organisation.
Query Parameters
- Name
next_cursor- Type
- string
- Restrictions
- Description
A pagination pointer supplied in a previous request for the next set of results.
- Name
previous_cursor- Type
- string
- Restrictions
- Description
A pagination pointer supplied in a previous request for the previous set of results.
- Name
limit- Type
- string
- Restrictions
- Description
The maximum number of results returned in the set.
- Name
carrier_handle- Type
- string
- Restrictions
- Description
A carrier handle to filter trackers by.
- Name
include_fields- Type
- array[string]
- Restrictions
- Description
A comma-separated list of fields to return in each object.
Enumerated Values
| Parameter | Value |
|---|---|
| include_fields | details |
| include_fields | shipments |
| include_fields | events |
Request
GET
/trackerscurl --request GET \
--url https://api.envoy.one/trackers \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response
{
"data": [
{
"id": "string",
"status": "pre_transit",
"tracking_code": "9461200104262208438927",
"tracking_url": "https://track.easypost.com/djE6dHJrX2NiMzg2NjU2OGQ4NDRhYzU4M2E2ODgyYTU1ODBhZmJj",
"shipments": [
{
"id": "shp_0ujzPyRiIAffKhBux4PvQdDqMHY",
"addresses": {
"destination": null,
"origin": null,
"return": null,
"location_configuration_id": null
},
"tax_identifiers": [
{}
],
"packages": [
{}
],
"customs": {
"contents_type": null,
"contents_description": null,
"declarant": null,
"incoterm": null,
"restriction_type": null,
"restriction_description": null,
"declaration_message": null,
"items": null,
"identifiers": null
},
"options": {
"shipping": null,
"label": null,
"insurance": null
},
"carrier": {
"carrier_code": null,
"service_code": null,
"carrier_accounts": null
},
"name": "ORDER-273548",
"documents": [
{}
],
"rates": [
"["
],
"service": "[Object]",
"status": "purchased",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"errors": [
{}
]
}
],
"details": {
"carrier": {
"id": "string",
"name": "string",
"handle": "string",
"services": null,
"predefined_packages": null,
"account_fields": null,
"accounts": null
},
"carrier_service": {
"id": "car_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "UPS",
"handle": "ups",
"description": "United Parcel Service"
},
"origin_location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
},
"destination_location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
},
"shipped_date": "2019-08-24T14:15:22Z",
"estimated_delivery_date": "2019-08-24T14:15:22Z",
"actual_delivery_date": "2019-08-24T14:15:22Z",
"guaranteed_delivery_date": "2019-08-24T14:15:22Z"
},
"events": [
{
"id": "te_2PcNWI9Fb82GvM2ijZ5xy8TRKLa",
"status": "pre_transit",
"message": "string",
"timestamp": "2019-08-24T14:15:22Z",
"source": "carrier",
"additional_data": "string",
"is_internal": true,
"location": {
"id": null,
"name": null,
"city": null,
"province": null,
"post_code": null,
"country_code": null,
"latitude": null,
"longitude": null
}
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"next_cursor": "WyIyMDIzLTAzLTIxVDAwOjM1OjU5LjczMDYyMVoiXQ==",
"previous_cursor": "WyIyMDIzLTAzLTE5VDA0OjI4OjAxLjQ4NDg5WiJd",
"limit": 20
}
undefined
GET/trackers/{id}
Get Tracker Details
Retrieves all information for a given tracker.
Path Parameters
- Name
id- Type
- string
- Restrictions
- Description
none
Request
GET
/trackers/{id}curl --request GET \
--url https://api.envoy.one/trackers/string \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response
{
"id": "string",
"status": "pre_transit",
"tracking_code": "9461200104262208438927",
"tracking_url": "https://track.easypost.com/djE6dHJrX2NiMzg2NjU2OGQ4NDRhYzU4M2E2ODgyYTU1ODBhZmJj",
"shipments": [
{
"id": "shp_0ujzPyRiIAffKhBux4PvQdDqMHY",
"addresses": {
"destination": {
"address": "[Object]",
"contact": "[Object]",
"display_name": "Work",
"metadata": "[Object]",
"marketplaces": "[Object]",
"coordinates": "[Object]"
},
"origin": {
"address": "[Object]",
"contact": "[Object]",
"display_name": "Work",
"metadata": "[Object]",
"marketplaces": "[Object]",
"coordinates": "[Object]"
},
"return": {
"address": "[Object]",
"contact": "[Object]",
"display_name": "Work",
"metadata": "[Object]",
"marketplaces": "[Object]",
"coordinates": "[Object]"
},
"location_configuration_id": "lc_2iFuzwcptRh9xt93ICDzK0vOszc"
},
"tax_identifiers": [
{
"taxable_entity_type": "sender",
"identifier_type": "ioss",
"value": "IM0123456789",
"issuing_country_code": "string"
}
],
"packages": [
{
"name": "string",
"geometry": {
"length": null,
"width": null,
"height": null,
"mass": null
},
"predefined_package_code": "string"
}
],
"customs": {
"contents_type": "merchandise",
"contents_description": "automobile parts",
"declarant": {
"name": "string",
"certify": true,
"date": null
},
"incoterm": "DDP",
"restriction_type": "other",
"restriction_description": "string",
"declaration_message": "string",
"items": null,
"identifiers": [
{
"entity_type": null,
"identifier_type": null,
"value": null,
"issuing_country_code": null
}
]
},
"options": {
"shipping": {
"access_code": "473281",
"commercial_address": false,
"currency_code": "USD",
"date": "2022-07-11T00:00:00.00Z",
"delivery_confirmation": false,
"dry_ice_mass": 2500,
"dropoff_type": "regular_pickup",
"handling_instructions": "Leave behind plant pot in front porch.",
"high_security": null,
"hold_for_pickup": false,
"invalid_address_handling": "forward_or_return",
"is_return": false,
"leave_safe": null,
"machinable": null,
"non_delivery": "return",
"restricted_substances": null,
"safe_place": "Garden Shed",
"saturday_delivery": false,
"signature_required": null,
"signature_type": "standard",
"tracked_service": null
},
"label": {
"format": "pdf",
"size": "4x6",
"custom_data": null
},
"insurance": {
"value": 55000,
"currency_code": "USD"
}
},
"carrier": {
"carrier_code": "string",
"service_code": "string",
"carrier_accounts": [
"string"
]
},
"name": "ORDER-273548",
"documents": [
{
"id": "doc_2iBgUNtezju7lmzmfOoJO8cnsVS",
"type": "label",
"file_name": "2iBgUMZPAyHoQlX2RnuaobI5yKk_label_0.png",
"file_type": "image/png",
"file_size": 129842,
"file_url": "https://envoy-shipment-files.s3.amazonaws.com/labels/2iBgUMZPAyHoQlX2RnuaobI5yKk_label_0.png?AWSAccessKeyId=AKIAY27LA84LC8DHB20X&Signature=kZY1RHl%2BBIClJ0UpjpKtAeqZqJA%3D&Expires=1725464510",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"rates": [
{
"id": "string",
"carrier": {
"id": "car_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "UPS",
"handle": "ups"
},
"carrier_service": {
"id": "cs_2iBgUNbKrgj7uVrsSiiF5ZhTelp",
"name": "Express",
"handle": "express"
},
"carrier_account": null,
"rate": 1650,
"currency_code": "USD",
"delivery_days": 3,
"ship_date": "2024-06-18T14:15:22Z",
"delivery_date": "2024-06-21T14:15:22Z",
"guaranteed_delivery_date": "2024-06-22T14:15:22Z"
}
],
"service": {
"rate": "rate_2iBgUKWHmQlBjYQyx9fAGMvcCEp",
"carrier": {
"id": "car_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "UPS",
"handle": "ups"
},
"carrier_service": {
"id": "cs_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "Express",
"handle": "express"
},
"carrier_account": {
"id": "ca_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "Main Account",
"handle": null
}
},
"status": "purchased",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"errors": [
{
"type": "rate_error",
"code": "rates_unavailable",
"source": "provider",
"message": "rates are not available for the provided shipment"
}
]
}
],
"details": {
"carrier": {
"id": "string",
"name": "string",
"handle": "string",
"services": [
null
],
"predefined_packages": [
{
"id": "pkg_2iHViqpO8v81j2e1nrpWkRuVfmo",
"name": "Tube",
"handle": "tube",
"description": "Triangular tube for rolled papers"
}
],
"account_fields": [
{
"name": "FedEx Cross Border Origin Hub",
"key": "origin_hub",
"type": "option",
"optional": false,
"option_values": null
}
],
"accounts": [
{
"id": "string",
"name": "UPS Main Account",
"description": "The main account for shipping all non-hazmat packages.",
"created_at": null,
"updated_at": null
}
]
},
"carrier_service": {
"id": "car_2iBgUOHPuWh0Hvjc81euqKXTW5N",
"name": "UPS",
"handle": "ups",
"description": "United Parcel Service"
},
"origin_location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
},
"destination_location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
},
"shipped_date": "2019-08-24T14:15:22Z",
"estimated_delivery_date": "2019-08-24T14:15:22Z",
"actual_delivery_date": "2019-08-24T14:15:22Z",
"guaranteed_delivery_date": "2019-08-24T14:15:22Z"
},
"events": [
{
"id": "te_2PcNWI9Fb82GvM2ijZ5xy8TRKLa",
"status": "pre_transit",
"message": "string",
"timestamp": "2019-08-24T14:15:22Z",
"source": "carrier",
"additional_data": "string",
"is_internal": true,
"location": {
"id": "tl_2PcKaWCquowSN6imoR0udGO6dim",
"name": "Depot T3",
"city": "HOUSTON",
"province": "TX",
"post_code": "77063",
"country_code": "US",
"latitude": 29.73034899775139,
"longitude": -95.51861606340167
}
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
undefined