Skip to content

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.
Operations

Publish parcel data

Request

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.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
eventTypestring(booking_type)required

The type of booking request.

Enum:"PRE_CHECK""BOOKING"
Example:"BOOKING"
lockerUidstringrequired

The unique identifier of the locker in the GLS/NXT Platform.

Example:"locker_567890"
carrierParcelIdstringrequired

The identifier of the parcel in the carrier's system.

Example:"A123456789"
shipmentTypestring(shipment_type_input)

The possible types of last-mile shipments accepted.

Enum:"LAST_MILE""ALTERNATIVE_DELIVERY"
Example:"LAST_MILE"
consigneeobject or null(consignee)

The details of the consignee.

dimensionsobject(dimensions)required

The dimensions of the parcel.

weightinteger

Weight in grams

Example:400
allocationTypestring(allocation_type)

The allocation type of the shipment.

Enum:"HARD_RESERVATION""SOFT_RESERVATION"
Example:"HARD_RESERVATION"
requiresAccessibleCompartmentboolean

Indicates whether the parcel requires an accessible compartment. Defaults to false when not present or null.

Default:false
Example:false
secondaryShipmentIdstring

A secondary identifier for the shipment, separate from carrierParcelId.

Example:"EXP-CODE-0001"
curl -i -X POST \
  https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/parcels/data \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "eventType": "BOOKING",
    "lockerUid": "locker_567890",
    "carrierParcelId": "A123456789",
    "shipmentType": "LAST_MILE",
    "consignee": {
      "name": "John Doe",
      "email": "[email protected]"
    },
    "dimensions": {
      "depth": 190,
      "height": 100,
      "width": 140
    },
    "weight": 400,
    "allocationType": "HARD_RESERVATION",
    "requiresAccessibleCompartment": false,
    "secondaryShipmentId": "EXP-CODE-0001"
  }'

Responses

Parcel event published successfully

Bodyapplication/json
statusstring

The status of the event processing.

Example:"success"
messagestring

A message providing additional information about the event processing.

Example:"Parcel event received and processed successfully"
timestampstring, (date-time)

The timestamp when the event was processed.

Example:"2023-06-18T10:45:00Z"
Response
{
  "status": "success",
  "message": "Parcel event received and processed successfully",
  "timestamp": "2023-06-18T10:45:00Z"
}