Introduction
Main Features
The GLS/NXT OOH Platform Integration API enables carriers to seamlessly integrate with the OOH Platform, facilitating quick and scalable adoption of lockers in their operational workflows.
🚚 Operations Overview
The API supports two main operations for parcel handling:
📦 Delivery Operations
- Purpose: Deliver parcels to lockers for consignee pickup
- Use Case: Ideal for last-mile deliveries
- Benefit: Provides consignees with flexible and convenient delivery options
🔄 Return Operations
- Purpose: Enable customers to return parcels and ship new ones using lockers
- Use Case: Supports first-mile returns
- Benefit: Allows customers to drop off items at designated lockers
🏪 Locker Management
Comprehensive capabilities for managing lockers:
| Operation | Description |
|---|---|
| Creation | Set up new lockers with location, size, and feature details |
| Retrieval | Fetch locker information including status and contained parcels |
| Updating | Modify locker details for status, location, or configuration changes |
📋 Parcel Management
The API provides three core parcel operations:
- 📤 Parcel Data Upload: Publish carrier parcel data to trigger locker bookings or pre-checks
- 📖 Get Parcel Information: Access real-time parcel data including status and event history
- ❌ Cancel Parcels: Cancel undelivered parcels to free up locker capacity
🔐 Authentication & Security
| Method | Purpose |
|---|---|
| ApiKeyAuth | General API access |
⚠️ Error Handling
Standard HTTP status codes with detailed error messages:
| Code | Status | Description |
|---|---|---|
200 | OK | Request successful |
400 | Bad Request | Malformed or invalid request |
401 | Unauthorized | Authentication failed or missing |
404 | Not Found | Requested resource not found |
500 | Internal Server Error | Unexpected server error |
Last modified on