Collection Events

Serverhttps://carrier.example.com/ooh

This webhook endpoint is designed to push events about lockers that require parcel collections.

Sporadic Collection: Events are pushed to notify the Carrier that lockers have parcels to be collected.

Webhook for pickup notifications

POST

https://carrier.example.com/ooh

/collection-notification

Webhook to push collection notifications to any URL provided by the carrier. Notifications are sent once per day, informing the carrier about parcels that need to be picked up from the lockers.

Webhook for pickup notifications › Request Body

collection_events

eventTimestamp

string · date-time · required

The timestamp of the collection event

lockerUid

string · required

The unique identifier of the locker in the GLS/NXT Platform

carrierLockerId

string · required

The unique identifier of the locker in the Carrier's system

object[] · required

courierAccessCode

string | null

Access code for the courier to collect parcels from locker. Access code rotates daily.

Webhook for pickup notifications › Responses

Return a 200 status to indicate that the data was received successfully.

No data returned

Parcel Events