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

id: The unique ID of the notification.
status: The status of the notification (e.g., PENDING, TRIGGERED).
name: The name of the notification indicating its purpose (e.g., DELIVERED_TO_CONSUMER).
channel: The channel through which the notification is sent (e.g., EMAIL, SMS).
tracking_number: Tracking number relevant to the notification, may be empty.
scheduled_at: The time at which the notification is scheduled to be triggered.
triggered_at: The time at which the notification was triggered.
origin: The origin of the notification (SYSTEM or RETRIGGER).

Available statuses

PENDING: The notification is scheduled to be triggered.
TRIGGERED: The notification has been triggered.
CANCELLED: The notification is canceled by the system (e.g. cancelled PICKUP_REMINDER because parcel was collected).
FAILED: The notification is failed when we unsuccessfully try to trigger it.

Available names

CONFIRMED_BY_MERCHANT: OrderConfirmedByMerchant is sent when Order is confirmed by merchant.
PREPARED_BY_MERCHANT: PreparedByMerchant is sent when Order changes step to STEP_PREPARED_BY_MERCHANT.
SUBMITTED_TO_CARRIER: SubmittedToCarrier is sent when Parcel or Order is submitted to carrier or is already in transit.
DELIVERED_TO_PICKUP_POINT: DeliveredToPickupPoint is sent when Parcel is delivered to pickup point.
DELIVERED_TO_CONSUMER: DeliveredToConsumer is sent when Parcel is delivered to consumer.
TERMINATED: Terminated is sent when the delivery is terminated by a Carrier and cannot be fulfilled.
SENT_BACK: SentBack is sent when Order is passively sent back to merchant.
RETURN_REQUESTED: ReturnRequested is sent in return flow when return is requested.
DELIVERED_TO_MERCHANT: DeliveredToMerchant is sent when return parcel is delivered to merchant.
AWAITING_SUPPLIER: AwaitingSupplier is sent when Order is awaiting supplier.
LINEHAUL_TO_CARRIER: LineHaulToCarrier is sent when Order is on its way to carrier using merchant's linehaul.
PICKUP_REMINDER: PickupReminder is sent when Parcel approaches pickup deadline.
ORDER_RECEIPT: OrderReceipt is sent when Order receipt is available.
ORDER_CANCELLED_BY_MERCHANT: OrderCancelledByMerchant is sent when Order is cancelled by merchant.
ORDER_CANCELLED_BY_CUSTOMER: OrderCancelledByCustomer is sent when Order is cancelled by customer.
ORDER_ITEMS_CANCELLED: OrderItemsCancelled is sent when Order items are cancelled.
RETURN_RECEIPT: ReturnReceipt is sent when return receipt is available.
OUT_FOR_DELIVERY: OutForDelivery is sent when Parcel is handed out for delivery.
DELIVERY_DELAYED: DeliveryDelayed is sent when Parcel delivery is delayed.
DELIVERY_FAILED: DeliveryFailed is sent when Parcel's delivery attempt has failed.
SUBMISSION_DELAYED: SubmissionDelayed is sent when Parcel submission to Carrier is delayed.
PRICE_ADJUSTMENT_RECEIPT: PriceAdjustmentReceipt is sent when price adjustment receipt is available.
RETURNED_IN_STORE: ReturnedInStore is sent when Parcel is returned in store.
RETURNED_TO_WAREHOUSE: ReturnedToWarehouse is sent when Parcel is returned to warehouse.
PARCEL_REFUSED_NO_REASON: ParcelRefusedNoReason is sent when Parcel is refused by consumer without providing a reason.
PARCEL_REFUSED_NOT_WANTED: ParcelRefusedNotWanted is sent when Parcel is refused by consumer because it is not wanted.
PARCEL_REFUSED_GOODS_DAMAGED: ParcelRefusedGoodsDamaged is sent when Parcel is refused by consumer because goods are damaged.
PARCEL_REFUSED_PACKAGING_DAMAGED: ParcelRefusedPackagingDamaged is sent when Parcel is refused by consumer because packaging is damaged.
PARCEL_NOT_COLLECTED: ParcelNotCollected is sent when Parcel is not collected by consumer.

Available channels

SMS_CHANNEL: Ingrid internal SMS Channel.
EMAIL_CHANNEL: Ingrid internal email Channel.
CEP_CHANNEL: Customer Engagement Platform channel, currently supports Emarsys.
REVIEW_PLATFORM_CHANNEL: Review Platform channel, currently supports Trustpilot.
INFOBIP_SMS_CHANNEL: Infobip provider SMS channel.
INFOBIP_EMAIL_CHANNEL: Infobip provider email channel.
API_NOTIFICATION_CHANNEL: API Notifications channel.
KLAVIYO_CHANNEL: Klaviyo channel.

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

site_id: The unique ID of the site.
notification_id: The unique ID of the notification to be retriggered.

Response fields

notification_id: The unique ID of newly scheduled notification.

Last updated: Fri, Sep 06, 06:15 AM