Update Locker Status

PATCH /lockers/status

Api key auth

Update the status of an existing locker.

application/json

Body Required

lockerUid string Required

The unique identifier of the locker in the GLS/NXT Platform
status string Required

Values are ACTIVE, INACTIVE, MAINTENANCE, or DECOMMISSIONED.

Responses

200

Locker status updated successfully.
400 application/json

Bad request due to invalid input.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
401 application/json

The requested resource requires authentication.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
404 application/json

The requested resource was not found.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
409 application/json

The request conflicts with the current state of the target resource
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
500 application/json

The server encountered an internal error.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.

PATCH /lockers/status

curl \
 --request PATCH 'https://api.staging.glsnxt.com/ooh/carrier-connector/v1/lockers/status' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"lockerUid":"anyLockerId123","status":"ACTIVE"}'

Request examples

{
  "lockerUid": "anyLockerId123",
  "status": "ACTIVE"
}

Response examples (400)

{
  "errorCode": "INVALID_REQUEST",
  "message": "Bad request due to invalid input"
}

Response examples (401)

{
  "errorCode": "UNAUTHORIZED",
  "message": "The requested resource requires authentication"
}

Response examples (404)

{
  "errorCode": "NOT_FOUND",
  "message": "The requested resource was not found"
}

Response examples (409)

{
  "errorCode": "CONFLICT",
  "message": "The locker status cannot be updated due to a conflicting state"
}

Response examples (500)

{
  "errorCode": "SERVER_ERROR",
  "message": "The server encountered an internal error"
}