Documentation

Providing Orders to Delivery Tracking

The Ingrid Delivery Tracking places its primary emphasis on order tracking, rather than focusing solely on individual parcels identified by tracking numbers. A single order may consist of multiple parcels, and each parcel can be tracked independently. However, well before a tracking number is assigned and the parcel is entrusted to the carrier for delivery, a wealth of information can be made available to the end consumer at the order level, enhancing the overall Tracking Experience.

There are multiple paths for providing Orders to Ingrid Tracking, depending on your Ingrid Products combination.

Using Ingrid Delivery Checkout

Ingrid Delivery Checkout (V1 and V2) and Ingrid Delivery Tracking work together for automatic order tracking. After a checkout session is completed, created order will be recognised by Delivery Tracking out of the box, making all the relevant data leveraged to deliver a comprehensive and satisfying Customer Experience.

Using Ingrid Transport Administration

Orders created directly from shipments in Ingrid Transport Administration (without Delivery Checkout) are automatically recognized and tracked by Delivery Tracking.

Registering orders created outside the Ingrid System

The most straightforward way of sourcing tracking orders is through Delivery Checkout and Ingrid Transport Automation service. However, if you use Ingrid Delivery Tracking exclusively or need to track orders that did not originate in another Ingrid system, you can still track them by providing all the necessary information using CreateTrackingOrder endpoint.

To register an exteral order, you need to make a POST request to v1/delivery_tracking/order

POST v1/delivery_tracking/order
Host: api.ingrid.com
Accept: application/json
Content-Type: application/json
Authorization: Bearer <BASE64-ENCODED-API-TOKEN>

{
"site_id": <site_id>,
"external_id": "order456",
"carrier_product_ref": "carrier123",
"delivery_type": "PICKUP",
"promises": {
"estimated_submission_time": {
"start": "2023-11-07T12:30:00Z",
"end": "2023-11-07T14:30:00Z"
},
"estimated_delivery_time": {
"start": "2023-11-07T15:00:00Z",
"end": "2023-11-07T17:00:00Z"
}
},
"sender": {
"name": "John Doe",
"address": {
"street": "123 Main St",
"city": "Stockholm",
"postal_code": "12345",
"country": "SE"
}
},
"receiver": {
"name": "Jane Smith",
"email": "jane@example.com",
"phone_number": "123-456-7890",
"address": {
"street": "456 Elm St",
"city": "Gothenburg",
"postal_code": "54321",
"country": "SE"
}
},
"destination": {
"address": {
"street": "789 Oak St",
"city": "Malmö",
"postal_code": "67890",
"country": "SE"
},
"operational_hours": {
"mon": [],
"tue": [
{
"start": "2023-11-07T10:00:00Z",
"end": "2023-11-07T16:00:00Z"
}
],
"wed": [],
"thu": [],
"fri": [],
"sat": [],
"sun": []
},
"location_external_id": "location456",
"location_type": "LOCKER"
},
"cart": {
"items": [
{
"sku": "item123",
"name": "Product A",
"quantity": 2,
"price": 2000,
"discount": 100,
"image": "https://example.com/productA.jpg"
},
{
"sku": "item456",
"name": "Product B",
"quantity": 1,
"price": 1500,
"discount": 0,
"image": "https://example.com/productB.jpg"
}
],
"total": 4400,
"discount": 100,
"shipping_price": 200,
"currency": "SEK"
}
}
HTTP/1.1 200 OK
Date: Tue, 10 May 2022 13:25:51 GMT
Content-Type: application/json

Connection: close
Vary: Accept-Encoding
x-trace-id: D20220314132550W4T98CK0A6AEQ72X

{
"id": "tracking_order_id123"
}
Note

The id obtained in the response can be used as tos_id while registering tracking parcels.

Last updated: Fri, Jul 12, 06:15 AM