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. Here are the main features:
1. Operations Overview
The API supports the two main operations related to the handling of parcels:
- Delivery Operations: Allows the carrier to deliver a parcel in a locker for consignees to pick up. This operation is ideal for last-mile deliveries, providing consignees with a more flexible and convenient delivery process.
- Return Operations: Enable customers to return parcels and ship new parcels using lockers. This operation supports first-mile returns, allowing customers to drop off items at designated lockers.
2. Locker Management
The API offers comprehensive capabilities for managing lockers, including:
- Creation: Set up new lockers with detailed information such as location, size, and features.
- Retrieval: Fetch information about existing lockers, including their status and the parcels they contain.
- Updating: Modify locker details to reflect changes in status, location, or configuration.
3. Parcel Management
The API provides endpoints to:
- Parcel Data Upload: Publish parcel data from the carrier into the OOH Platform, enabling carriers to trigger locker bookings or pre-checks at the appropriate time.
- Get Parcel Information: Access parcel data on demand, including their current status and event history.
- Cancel Parcels: Cancel undelivered parcels to free up locker capacity when parcels are assigned to different delivery addresses.
4. Carrier Management
The API provides endpoints to:
- Manage Expiry Times: Configure parcel expiry times for different stages in the delivery process.
- Manage Redirection Options: Set up and manage redirection settings for notifications and other configurations.
- Manage Sporadic Collections: Configure sporadic collection settings to optimize courier pickups.
5. Courier and Consumer App Session Management
The API enables the creation and management of sessions for both couriers and end-users mobile apps. This ensures secure, authenticated, and traceable access to parcel handling (delivery and pickup).
- Detailed Interactions Log: Maintain a detailed log of interactions to monitor and audit courier and consumer activities.
6. Authentication and Security
Security is a top priority, and the API supports multiple authentication methods to ensure secure access:
- ApiKeyAuth: General API access.
- AppKeyAuth: Specific to Courier and End-User apps.
7. Error Handling
Standard HTTP status codes are used to indicate the success or failure of requests. Detailed error messages help diagnose issues. Common status codes include:
- 200 OK: The request was successful.
- 400 Bad Request: The request was malformed or invalid.
- 401 Unauthorized: Authentication failed or was not provided.
- 404 Not Found: The requested resource was not found.
- 500 Internal Server Error: An unexpected error occurred on the server.
8. Flexible and Scalable
The API is designed to be flexible and scalable, supporting various use cases and integration needs. It allows carriers to efficiently manage their operations and resources, offering:
- Customizable Settings: Configure parcel expiry times, email notifications, and other settings.
- Real-time Updates: Receive immediate updates on locker and parcel statuses.
- Comprehensive Data Access: Retrieve detailed information on lockers, parcels, and user interactions.