Skip to content

Webhook for pickup notifications
Webhook

Request

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.

Security
ApiKeyAuth
Bodyapplication/json

Information about locker collections.

eventTimestampstring, (date-time)

The timestamp of the collection event

Example:"2025-08-20T00:00:00Z"
lockerUidstring

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

Example:"8979879823"
carrierLockerIdstring or null

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

Example:"GHX1234"
courierAccessCodestring or null

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

Example:"342156"
parcelsArray of objects
Payload
{
  "eventTimestamp": "2025-08-20T00:00:00Z",
  "lockerUid": "8979879823",
  "carrierLockerId": "GHX1234",
  "courierAccessCode": "342156",
  "parcels": [
    { … }
  ]
}

Responses

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