Object Reference

Address

Common address entity that used almost everywhere in Ingrid's API.

Any

Coordinates

Geolocation coordinates

DeliveryType

Indicates the type of the delivery

Destination

Error

EstimatedTimeOfArrival

GetTrackingEventsResponse

LineItem

Location

Location is a location where a tracking event occurred

LogisticUnit

PickupLocationType

Indicates the kind of pickup location

PickupPointDetails

Receiver

Sender

Status

- UNKNOWN: UNKNOWN indicates an unknown status which could not be harmonized.
- ORDER_CREATED: ORDER_CREATED indicates that the order has been registered in Ingrid system.
- ORDER_BOOKED: ORDER_BOOKED indicates that the order has been booked by the merchant.
- PICKUP_BOOKING_SCHEDULED: PICKUP_BOOKING_SCHEDULED indicates that booking service will include the delivery in the next booking operation.
- PICKUP_BOOKED: PICKUP_BOOKED indicates that the delivery has been successfully booked with the carrier.
- IN_TRANSIT: IN_TRANSIT indicates that the delivery is under transportation to pickup point or in line haul.
- DELIVERY_IN_PROGRESS: DELIVERY_IN_PROGRESS indicates that the delivery is on its way to a customers home address.
- ARRIVED_AT_PICKUP_POINT: ARRIVED_AT_PICKUP_POINT indicates that the delivery is ready for pickup at a pickup location.
- DELIVERED: DELIVERED indicates that the delivery has been delivered to the customer.
- CANCELED: CANCELED indicates that the delivery has been suspended and will not proceed.
- DELAYED: DELAYED indicates that the delivery is delayed but will resume at a later time.
- RETURNED: RETURNED indicates that the delivery has been returned.
- INFO: INFO indicates some custom event.
- ERROR: ERROR indicates that some error occurred.
- SHIPMENT_CREATED: SHIPMENT_CREATED indicates that a shipment has been created in SOM.
- LOGISTIC_UNIT_CREATED: LOGISTIC_UNIT_CREATED indicates that a logistic unit / (parcel-delivery) has been created in SOM.
- LOGISTIC_UNIT_RECEIVED_TRACKING_NUMBER: LOGISTIC_UNIT_RECEIVED_TRACKING_NUMBER indicates that a logistic unit has received a tracking number.
- NOTIFICATION_SENT: NOTIFICATION_SENT indicates that a delivery notification has been sent to the customer.
- BOOKING_RECEIVED_BY_CARRIER: BOOKING_RECEIVED_BY_CARRIER indicates that the carrier has received booking information for the parcel.
- FAILED: FAILED indicates that there was an attempt to deliver the package but it failed.
- ARRIVED_AT_DISTRIBUTION_TERMINAL: ARRIVED_AT_DISTRIBUTION_TERMINAL indicates that the shipment has arrived to a distribution terminal and is waiting for final delivery
- ON_HOLD: ON_HOLD indicates that the shipment is held up at the moment and some action is required.
- RECEIVED_AT_PICKUP_POINT: RECEIVED_AT_PICKUP_POINT indicates that the package was put into a pickup locker.
- DEPARTED_FROM_PICKUP_POINT: DEPARTED_FROM_PICKUP_POINT indicates that the package departed a pickup locker.
- SHIPMENT_CANCELED: SHIPMENT_CANCELED indicates that a shipment has been canceled in SOM.
- TRACKING_NUMBER_REGISTERED: TRACKING_NUMBER_REGISTERED indicates that the tracking number has been registered.
- CUSTOM: CUSTOM indicates that event type was defined by external party.
- LABEL_CREATED_BY_CARRIER: LABEL_CREATED_BY_CARRIER indicates that the label was created by carrier.
- PICKUP_FAILED: PICKUP_FAILED indicates that the carrier failed to pickup the parcel.
- RETURN_PICKUP_SCHEDULED: RETURN_PICKUP_SCHEDULED indicates that a return pickup has been booked.
- FORWARDED_TO_THIRD_PARTY: FORWARDED_TO_THIRD_PARTY indicates that the package was handed over to another third party for continuation of delivery.
- IN_CUSTOMS: IN_CUSTOMS indicates that the package is undergoing customs clearance.
- REDIRECTED: REDIRECTED indicates that package has been redirected from its original path.
- LOST: LOST indicates that package has been lost and delivery cannot proceed.
- DAMAGED: DAMAGED indicates that package has been damaged.
- RETURNED_TO_SENDER: RETURNED_TO_SENDER indicates that package will be returned to the sender.
- PICKUP_DELAYED: PICKUP_DELAYED means the carrier will try to pick up the shipment again or that the sender has rescheduled the pick-up date for the shipment.
- PICKED_UP: PICKED_UP indicates that the package was received from the point of origin.
- UNDELIVERABLE: UNDELIVERABLE indicates that the package cannot be delivered.
- CONTACT_MERCHANT_SUPPORT: CONTACT_MERCHANT_SUPPORT indicates that the consumer should contact merchant's customer support.
- CONTACT_CARRIER_SUPPORT: CONTACT_CARRIER_SUPPORT indicates that the consumer should contact carrier's customer support.
- DELIVERY_PROMISE_EXCEEDED: DELIVERY_PROMISE_EXCEEDED status is deprecated in favour of ESTIMATED_DELIVERY_TIME_EXCEEDED.
- ESTIMATED_DELIVERY_TIME_EXCEEDED: ESTIMATED_DELIVERY_TIME_EXCEEDED indicates that the current ETA has been exceeded.
- ESTIMATED_DELIVERY_TIME_UPDATED: ESTIMATED_DELIVERY_TIME_UPDATED indicates that ETA has been updated.
- ESTIMATED_SUBMISSION_TIME_EXCEEDED: ESTIMATED_SUBMISSION_TIME_EXCEEDED indicates that the package pickup from point of origin is delayed.
- ESTIMATED_SUBMISSION_TIME_UPDATED: ESTIMATED_SUBMISSION_TIME_UPDATED indicates that ETS has been updated.
- ORDER_RECEIPT_AVAILABLE: ORDER_RECEIPT_AVAILABLE indicates that the order receipt is available for the consumer.
- ORDER_CONFIRMED_BY_MERCHANT: ORDER_CONFIRMED_BY_MERCHANT indicates that the order has been confirmed by merchant.
- ORDER_CANCELLED_BY_MERCHANT: ORDER_CANCELLED_BY_MERCHANT indicates that the order has been cancelled by merchant.
- ORDER_CANCELLED_BY_CUSTOMER: ORDER_CANCELLED_BY_CUSTOMER indicates that the order has been cancelled by customer.
- ORDER_ITEMS_CANCELLED: ORDER_ITEMS_CANCELLED indicates that the delivery does not contain all items from original order.
- RETURN_RECEIPT_AVAILABLE: RETURN_RECEIPT_AVAILABLE indicates that the return receipt is available for the consumer.
- PREPARED: PREPARED indicates that the order items have been prepared by the merchant.
- SUBMITTED: SUBMITTED indicates that the order items have been submitteds to carrier.
- AWAITING_SUPPLIER: AWAITING_SUPPLIER indicates that the merchant is awaiting item delivery from their supplier.
- LINEHAUL_TO_CARRIER: LINEHAUL_TO_CARRIER indicates that ordered items are being transported to carrier.
- ESTIMATED_PREPARATION_TIME_EXCEEDED: ESTIMATED_PREPARATION_TIME_EXCEEDED indicates that order items are taking longer than promised to prepare.
- ESTIMATED_PREPARATION_TIME_UPDATED: ESTIMATED_PREPARATION_TIME_UPDATED indicates that the preparation promise for order items has been updated.
- CENTRA_ORDER_CONFIRMED: CENTRA_ORDER_CONFIRMED indicates that the order has been confirmed in Centra platform.
- INSTORE_ARRIVED_AT_PICKUP_POINT: `service-instore` specific statuses INSTORE_ARRIVED_AT_PICKUP_POINT indicates that the delivery is ready for pickup at a pickup location.
- INSTORE_PARCEL_REFUSED: INSTORE_PARCEL_REFUSED indicates that the parcel has been refused by the customer.
- INSTORE_PARCEL_PICKED_UP: INSTORE_PARCEL_PICKED_UP indicates that the parcel has been picked up by the customer.
- INSTORE_PARCEL_OVERDUE: INSTORE_PARCEL_OVERDUE indicates that the parcel has not been picked up by the customer, and is overdue.
- INSTORE_PARCEL_RETURNED: INSTORE_PARCEL_RETURNED indicates that the parcel has been returned by the customer. It's indicates RETURN direction.
- INSTORE_PARCEL_RELOCATED: INSTORE_PARCEL_RELOCATED indicates that the parcel has been relocated by store staff.
- PRICE_ADJUSTMENT_RECEIPT_AVAILABLE: PRICE_ADJUSTMENT_RECEIPT_AVAILABLE indicates that the price adjustment receipt is available for the consumer.
- NOTIFICATION_TRIGGERED: NOTIFICATION_TRIGGERED indicates that a tracking notification has been triggered in the Ingrid Tracking system.
- NOTIFICATION_DELIVERED: NOTIFICATION_DELIVERED indicates that a delivery notification has been successfully delivered to the customer.
- NOTIFICATION_FAILED: NOTIFICATION_FAILED indicates that a delivery notification has been failed to reach the customer.
- ORDER_RETURNED_IN_STORE: ORDER_RETURNED_IN_STORE indicates that the order has been returned in merchant's store.
- ORDER_RETURNED_TO_WAREHOUSE: ORDER_RETURNED_IN_STORE indicates that the order has been returned to the merchant's warehouse.
- PAYMENT_DECLINED: PAYMENT_DECLINED indicates that we got PaymentDeclined exception.
- NOT_COLLECTED_BY_CUSTOMER: NOT_COLLECTED_BY_CUSTOMER indicates that package/order was not collected in the pickup point.
- REMAINING_SHIPMENTS_CANCELLED: REMAINING_SHIPMENTS_CANCELLED see RemainingShipmentsCancelled message comment.
- CENTRA_DELIVERY_GROUP_CANCELLED: CENTRA_DELIVERY_GROUP_CANCELLED indicates that the delivery group has been cancelled in centra.
- PICKUP_REMINDER_TRIGGERED: PICKUP_REMINDER_TRIGGERED indicated that a reminder to pick up a parcel was triggered.
- ORDER_RETURNED: ORDER_RETURNED indicates that the order has been returned.
- ORDER_CANCELLED: ORDER_CANCELLED indicates that the order has been cancelled.
- RETURN_REQUESTED: RETURN_REQUESTED indicates that the return process has been requested by the customer or merchant. Strictly in the RETURN direction parcel.
- INSTORE_PARCEL_SEND_ACCEPTED: INSTORE_PARCEL_SEND_ACCEPTED indicates that parcel was accepted in the store, but it does not belong to any order.
- READY_FOR_PICKUP: READY_FOR_PICKUP indicates that a parcel is ready to be collected in the pickup location, whether a carrier-managed location such as a locker or in a merchant-owned store.
- PICKED_UP_BY_CUSTOMER: PICKED_UP_BY_CUSTOMER indicates that a parcel was picked up from the pickup location, whether a carrier-managed location such as a locker or in a merchant-owned store.

TrackingEvent