# Parcel API

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.


## Publish parcel data

 - [POST /parcels/data](https://docs.glsnxt.com/openapi-carrier-integration-api/parcel-api/publishparceldata.md): This endpoint allows the Carriers to publish parcel data into the OOH Platform. It should be used to push parcel data at the time when the locker booking is expected to take place or to pre-check if a parcel can be accepted in the locker.


## Publish parcel data with carrier locker id

 - [POST /parcels/data/by-tenant-locker-id](https://docs.glsnxt.com/openapi-carrier-integration-api/parcel-api/publishparceldatabytenantid.md): This endpoint is an alternative to  endpoint and could be used to publish parcel data using carrierLockerId instead of lockerUid.


## Get parcels

 - [GET /parcels](https://docs.glsnxt.com/openapi-carrier-integration-api/parcel-api/getparcels.md): Retrieve a list of parcels associated with the carrier. This endpoint allows fetching detailed information about parcels, including their status and history.


## Cancel parcel

 - [PATCH /parcels/{parcelId}](https://docs.glsnxt.com/openapi-carrier-integration-api/parcel-api/cancelparcel.md): Cancel the booking of a specific parcel. Only parcels that haven’t been delivered can be cancelled. This endpoint allows carriers to manage cancellations effectively.