Trigger locker event

Request

Triggers a locker status event for the specified provider. For AMAZON_DE and CAINIAO_FR, include provider_payload. GLS/NXT supplies the required payload. Other providers do not need provider_payload.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

provider_locker_idstringrequired

Provider-side locker identifier.

Example:"99663306"

provider_namestringrequired

Locker provider name.

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

Example:"KEBA"

locker_statusstringrequired

Target locker status.

Enum:"ACTIVE""INACTIVE"

Example:"ACTIVE"

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_payloadobject

Required for AMAZON_DE and CAINIAO_FR. GLS/NXT supplies the payload. Do not include this field for KEBA and other providers that do not need it.

curl -i -X POST \
  https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/locker/event \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "provider_locker_id": "99663306",
    "provider_name": "KEBA",
    "carrier_name": "GLS_NXT",
    "locker_status": "ACTIVE"
  }'

Responses

Event triggered successfully.

Bodyapplication/json

messagestring

Example:"Locker event triggered successfully"

Response

{
  "message": "Locker event triggered successfully"
}