GLS/NXT OOH Platform Integration REST API

The Locker API endpoints provide comprehensive management of lockers, including their creation, updating, and retrieval. These endpoints support:

• Locker Creation: Set up new lockers with necessary details such as location, internal carrier IDs, and specific locker features.
• Locker Information Retrieval: Access detailed information about lockers, including their status and location.
• Locker Updates: Update existing locker details to reflect changes in status or configuration.

Key Features:

• Flexible Locker Management: Create and update lockers to keep information current and accurate.
• Detailed Location Data: Access geographic and logistical details of each locker.
• Compartment Management: Manage the availability and allocation of compartments within lockers.

The Locker Group API endpoints let carriers organise their lockers into named, typed groups. These endpoints support:

• Type Catalog: Retrieve the global catalog of available locker group types.
• Group Management: Create, rename, retrieve, list, and delete locker groups.
• Locker Assignment: Assign and remove the carrier's lockers to and from a group.

Key Features:

• Typed Groups: Each group has a type from the shared catalog; a locker may belong to at most one group per type key.
• Carrier-scoped: Groups and their lockers are scoped to the calling carrier.

The Network API endpoints provide management of locker networks, enabling carriers to share lockers between network owners and tenants. These endpoints support:

• Network Listing: View all networks where the carrier is the owner or tenant.
• Network Locker Management: Add, remove, and update lockers within a network.
• Paginated Locker Retrieval: Retrieve lockers in a network with filtering and pagination.

Key Features:

• Locker Sharing: Share lockers between carriers through networks.
• Status Management: Track and update locker status within networks (e.g., PENDING, ACCEPTED, DECLINED).
• Carrier Details: Optionally update carrier-specific details when managing network lockers.

The Parcel API endpoints are focused on the management of the parcel bookings. It allows for Carrier to publish parcel data for respective locker booking creation, the retrieval of parcel information and cancellation of parcel bookings.

• Parcel Data Publishing: Publish parcel data from the Carrier into the OOH Platform, enabling carriers to trigger locker bookings or pre-checks at the appropriate time.
• Parcel Information Retrieval: Fetch details of parcels, including status, and event history.
• Parcel Cancellation: Cancel parcel booking for parcels that are no longer to be delivered into the locker.

Key Features:

• Real-time Parcel Bookings: Push real-time parcel data to the OOH Platform to perform bookings at any time.
• Comprehensive Parcel Data: Retrieve detailed information on parcel booking status and history.
• Cancellation Flexibility: Cancel undelivered parcels to manage logistics effectively.