Receiving Real-Time Updates

Sending locker codes or catching shipment status updates in real-time.

Use the ShipmentStatusUpdate callback message to send locker codes to the correct user or catch the shipment status updates in real-time.

Make sure you've correctly configured and implemented the Callback url. When you've configured the callback url you will automatically receive update messages when a shipment's status has changed.

If a shipment's status has changed a ShipmentStatusUpdate callback message will be sent to the callback url. You should check both the stateCode and shipmentType fields. When both fields equal to a specific combination (see table below) a parcel can be picked up by or be delivered by an end-user. When such a message is delivered you can query the locker code using a corresponding call to GetShipments. Set the ShipmentUid of that call to the ShipmentUid you've received in the `ShipmentStatusUpdate callback message. Make sure you send the correct locker code to the enduser.

shipmentType	stateCode	Locker Code
ReceiveShipment	ReadyForPickup	PickUpCode
DispatchShipment	ReadyForDropOff	DeliveryCode
LocalPupShipment	ReadyForDropOff or ReadyForPickup	DeliveryCode or PickUpCode