Trigger last-mile event

Request

Triggers one last-mile parcel event for the selected provider and carrier. Sending COURIER_DELIVERED as the first event for a given parcel_id creates the booking and sets that status in one step. If the first event sent for a parcel_id is anything other than COURIER_DELIVERED, it is ignored. Once COURIER_DELIVERED has been triggered, send further calls with later statuses to advance the same shipment.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

parcel_idstringrequired

Unique parcel identifier.

Example:"000123456789"

provider_locker_idstringrequired

Provider-side locker identifier.

Example:"99663306"

event_typestringrequired

Event to trigger.

Enum:"COURIER_DELIVERED""CONSIGNEE_COLLECTED""CONSIGNEE_COLLECTION_EXPIRED""BOOKING_CANCELLED""COURIER_COLLECTED_EXPIRED""COURIER_DELIVERY_ERROR"

Example:"COURIER_DELIVERED"

carrier_namestringrequired

Carrier name.

Enum:"GLS_NXT""GLS_DE""GLS_AT""DPD_DE""GLS_ES""GLS_IT""GLS_PT""GLS_DK""GLS_FR""RMG_UK"

Example:"GLS_NXT"

provider_namestringrequired

Locker provider name.

Enum:"KEBA""MYFLEXBOX_DE""MYFLEXBOX_AT""TAMBURI_AT""LOCKY_PT""QUADIENT""BLOQ""AMAZON_DE""CAINIAO_FR"

Example:"KEBA"

shipment_typestringrequired

LAST_MILE or ALTERNATIVE_DELIVERY.

Enum:"LAST_MILE""ALTERNATIVE_DELIVERY"

Example:"LAST_MILE"

curl -i -X POST \
  https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/parcel/last-mile/event \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "parcel_id": "000123456789",
    "provider_locker_id": "99663306",
    "provider_name": "KEBA",
    "carrier_name": "GLS_NXT",
    "shipment_type": "LAST_MILE",
    "event_type": "COURIER_DELIVERED"
  }'

Responses

Event triggered successfully. Body may include message, parcel_id, and event_type.

Bodyapplication/json

messagestring

Example:"Last Mile event triggered successfully"

parcel_idstring

Example:"000123456789"

event_typestring

Example:"COURIER_DELIVERED"

Response

{
  "message": "Last Mile event triggered successfully",
  "parcel_id": "000123456789",
  "event_type": "COURIER_DELIVERED"
}