Documentation

Overview

Ingrid Tracking Notifications API is a set of endpoints that allows listing and retrigerring of notifications for a particular order. It is a part of the Ingrid Delivery Tracking solution and is designed to enhance the tracking experience by providing a proactive communication with the end customer.

Ingrid Delivery Tracking API

ListNotifications allows for listing of all notifications for a particular order.

Retrigger allows for retrigerring of a particular notification.

ListNotifications

This endpoint returns a list of all notifications for a particular order.

GET /v1/delivery_tracking/notifications?site_id=<SITE_ID>&external_id=<EXTERNAL_ID> HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <BASE64-ENCODED-API-TOKEN>
HTTP/1.1 200 OK
Date: Fri, 28 Oct 2022 16:07:11 GMT
Content-Type: application/json
Vary: Accept-Encoding

{
"notifications": [
{
"id": "52633b2f-18de-4287-aa5a-6184aa279017",
"status": "TRIGGERED",
"name": "OUT_FOR_DELIVERY",
"channel": "CEP_CHANNEL",
"tracking_number": "track123",
"scheduled_at": "2023-04-01T10:00:00Z",
"triggered_at": "2023-04-01T10:05:00Z",
"origin": "SYSTEM"
},
{
"id": "386a8c47-e437-45da-b2f0-7e5a76f7cb7d",
"status": "PENDING",
"name": "DELIVERED_TO_CONSUMER",
"channel": "CEP_CHANNEL",
"tracking_number": "track123",
"scheduled_at": "2023-04-02T15:00:00Z",
"triggered_at": "2023-04-02T15:20:00Z",
"origin": "SYSTEM"
}
]
}

Response fields

Available statuses

Available names

Available channels

Retrigger

This endpoint allows for retriggering of a particular notification.

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

{
"site_id": "123",
"notification_id": "123"
}
HTTP/1.1 200 OK
Date: Fri, 28 Oct 2022 16:07:11 GMT
Content-Type: application/json
Content-Length: 656
Vary: Accept-Encoding

{
"notification_id": "retriggered-notif-1234"
}

Request fields

Response fields

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