Webhook for pickup notifications

POST https://webhook.example.com
Api key auth App key auth

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.

application/json

Body

Information about locker collections.

  • eventTimestamp string(date-time)

    The timestamp of the collection event

  • lockerUid string

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

  • carrierLockerId string | null

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

  • courierAccessCode string | null

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

  • parcels array[object]
    Hide parcels attribute Show parcels attribute object
    • carrierParcelId string

      The identifier of the parcel in the carrier's system

Responses

  • 200

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

  • 401

    Return a 401 status to indicate that the POST was unauthorized.

  • 500

    Return a 500 status to indicate that the POST was unsuccessfully processed.

POST CollectionNotification
Request examples 
{
  "eventTimestamp": "2025-08-20T00:00:00Z",
  "lockerUid": "lockerUID123",
  "carrierLockerId": "Locker1",
  "courierAccessCode": "anyValidCode123",
  "parcels": [
    {
      "carrierParcelId": "anyCarrierParcelId123"
    }
  ]
}