API Reference
  1. GLS:NXT OOH Platform Integration REST API
  2. Locker Events

Webhook for locker updates

wbhk
LockerUpdates

Webhook to push locker updates to any URL provided by the carrier. This endpoint allows carriers to receive
real-time updates about lockers.

Payload

Information about locker updates.

string

The internal unique identifier assigned to the locker.

carrier
object

The details of the locker on the Carrier's system.

provider
object

The details of the locker on the Provider's system.

location
object

Details about the geographical location of the locker.

features
object

Features available in the locker.

metadata
array of objects

Additional metadata associated with the locker.

metadata
compartmentTypes
array of objects | null

A list of different compartment types available in the locker.

compartmentTypes
date-time

The timestamp of the locker status update.

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.

Updated 7 months ago

Did this page help you?
LoadingLoading…

Updated 7 months ago

Did this page help you?