This section of documentation refers to no longer a maintained feature. If you want to use Delivery Tracking go to Delivery Tracking v2
Object Reference
Address
Common address entity that used almost everywhere in Ingrid's API.
address_lines 🔗 |
string[]
List of address lines part of address such as street and building number |
apartment_number 🔗 |
string
Number of the apartment |
attn 🔗 |
string
optional
Attention field. Can be used to indicate an employee if the address is a company address |
care_of 🔗 |
string
optional
Care of part of address usually written as `c/o` |
city 🔗 |
string
Name of the city |
coordinates 🔗 |
Geolocation coordinates of the address. If reverse geolocation lookup of the address was successful this property will be populated. If coordinates are available they will be used to in service point search. In case of `search_address` coordinates can also be set by merchant if known |
country 🔗 |
string
Country should be specified as two uppercase letters (ISO Alpha-2). Example `SE` for Sweden, `ES` for Spain |
door_code 🔗 |
string
optional
The door code to the main entrance of the building if applicable |
floor_number 🔗 |
string
optional
Floor number |
name 🔗 |
string
Customer or company name |
postal_code 🔗 |
string
Postal code (or zipcode in US) |
region 🔗 |
string
optional
Region can be a state or a province |
street 🔗 |
string
Name of the street |
street_number 🔗 |
string
Number of the street |
subregion 🔗 |
string
optional
Further division of regions. Example countries are GB, IE, IT, LT, MX For example for The Republic Of Ireland there are 4 provinces (regions), e.g. `Connacht` and 26 counties (subregions), e.g. `Galway` Format is ISO 3166 where applicable, exceptions are e.g. Mexico |
Any
Coordinates
Geolocation coordinates
Destination
address 🔗 | |
pickup_point_details 🔗 |
pickup_point_details is only used when delivery is to pickup point or store |
Error
EstimatedTimeOfArrival
earliest 🔗 |
string
Earliest delivery date in RFC3339 format. No specific time of day is promised if the time part is 00:00:00 |
latest 🔗 |
string
Latest delivery date in RFC3339 format. No specific time of day is promised if the time part is 00:00:00 |
source 🔗 |
string
Source indicates where does the ETA information comes from |
GetTrackingEventsResponse
line_items 🔗 | |
logistic_unit 🔗 |
logistic_unit is a logistic unit connected to the TOS ID |
receiver 🔗 | |
sender 🔗 | |
shop_name 🔗 |
string
ShopName is used to determine merchant logo on tracking widget |
tracking_link 🔗 |
string
Tracking link is url that forwards to external tracking site |
tracking_method_logo 🔗 |
string
TrackingMethodLogo is used to determine the logo that should be displayed for the end customer |
LineItem
Location
Location is a location where a tracking event occurred
LogisticUnit
delivery_id 🔗 |
string
delivery_id is the delivery ID associated with the tracking event |
delivery_type 🔗 | |
estimated_time_of_arrival 🔗 |
Earliest and/or latest time when the parcel is estimated to arrive to its destination |
shipping_method 🔗 |
string
shipping_method is the method by which the shipment is transported |
tracking_events 🔗 |
tracking_events is a list of tracking events |
tracking_number 🔗 |
string
tracking_number is the tracking number assigned by a carrier |
PickupPointDetails
Receiver
destination 🔗 |
Sender
TrackingEvent
created_at 🔗 |
string
created_at is the RFC3339 nano formatted time when the event occurred |
location 🔗 |
Location is the location where the event took place |
origin_status 🔗 |
string
origin_status is a status code defined by the carrier or merchant |
origin_status_description 🔗 |
string
origin_status_description is a human readable status description from the carrier |
source 🔗 |
string
source is the name of the carrier or merchant from which the event originates from |
status 🔗 |
status is status code defined by Ingrid (i.e Order received, Delivered, etc) |