Trigger first-mile event

Request

Triggers one first-mile parcel event for the selected provider and carrier.

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:"BOOKING_CREATED""COURIER_COLLECTED""CONSIGNEE_DELIVERED"

Example:"CONSIGNEE_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""QUADIENT""BLOQ""CAINIAO_FR"

Example:"KEBA"

shipment_typestringrequired

FIRST_MILE or RETURN.

Enum:"FIRST_MILE""RETURN"

Example:"FIRST_MILE"

labellessboolean

Optional. Set true only for confirmed label-less combinations.

Example:false

curl -i -X POST \
  https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/parcel/first-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": "FIRST_MILE",
    "event_type": "CONSIGNEE_DELIVERED"
  }'

Responses

Event triggered successfully. Body may include message and event_type.

Bodyapplication/json

messagestring

Example:"First Mile event triggered successfully"

event_typestring

Example:"CONSIGNEE_DELIVERED"

Response

{
  "message": "First Mile event triggered successfully",
  "event_type": "CONSIGNEE_DELIVERED"
}