Publish parcel data with carrier locker id

Request

This endpoint is an alternative to /parcels/data endpoint and could be used to publish parcel data using carrierLockerId instead of lockerUid.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

eventTypestring(booking_type)required

The type of booking request.

Enum:"PRE_CHECK""BOOKING"

Example:"BOOKING"

carrierLockerIdstringrequired

The unique identifier of the locker in the Carrier Platform.

Example:"LOCKER123"

carrierParcelIdstringrequired

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

Example:"12345KL6789M"

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:300

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

curl -i -X POST \
  https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/parcels/data/by-tenant-locker-id \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "eventType": "BOOKING",
    "carrierLockerId": "LOCKER123",
    "carrierParcelId": "12345KL6789M",
    "shipmentType": "LAST_MILE",
    "consignee": {
      "name": "John Doe",
      "email": "[email protected]"
    },
    "dimensions": {
      "depth": 190,
      "height": 100,
      "width": 140
    },
    "weight": 300,
    "allocationType": "HARD_RESERVATION",
    "requiresAccessibleCompartment": false
  }'

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"
}