GLS/NXT
OOH Platform
Provider API

Provider API

Download schema

This page has two groups of calls: the webhooks that GLS/NXT sends, and the operations that locker providers call.

Webhooks

Webhooks provide real-time updates on locker and parcel statuses by pushing notifications to specified URLs. This ensures Carriers stay informed about relevant events as they happen.

Webhook endpoints are designed to push updates about lockers, parcels, and other events to URLs provided by the Carrier. These endpoints include:

  • Locker Events: Enables carriers to receive real-time updates about locker status and details.
  • Parcel Events: Allows carriers to receive notifications about changes in parcel status.
  • Collection Events: Daily notifications about parcels that need to be picked up from lockers.

Key Features:

  • Real-time Updates: Push notifications for immediate awareness of changes.
  • Customizable URLs: Configure URLs to receive specific event updates.

Locker provider operations

The Locker Provider API section has the operations that a locker provider calls on GLS/NXT:

  • Validation: The locker asks if it can accept a parcel for a first-mile or last-mile deposit, or if a labelless reference code is still free, before it opens a compartment.
  • Label printing: The locker gets a label PDF for a parcel.

A provider sends these calls to the provider connector URL with its provider API key in the X-API-Key header. Carriers do not call these operations.

Tags
Locker Provider API
Operations that a locker provider calls: validation before a locker accepts a parcel or opens a compartment, and label printing. Carriers do not call these operations.
For locker providers Base URL: https://api.glsnxt.com/ooh/provider-connector (staging: https://api.staging.glsnxt.com/ooh/provider-connector). Authenticate with your provider API key in the X-API-Key header. Each operation is enabled for each provider separately. A key that cannot use an operation gets 401.
For a validation, the platform does not decide the answer itself. It asks the carrier that owns the parcel and returns the result. When the answer is not a success status, the locker must not accept the parcel and must not open the compartment.
Locker Events
This webhook endpoint is designed to push events about locker updates.
  • New Locker: An event will be pushed when a new Locker is created.
  • Locker status: An event is pushed when the locker status changes (enabled/disabled).
Parcel Events
This webhook endpoint is designed to push updates about parcels handling events.
  • Parcel Updates: Get notifications about changes in parcel status.
Collection Events
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.