Update locker service state

PATCH

/lockers/{lockerId}

Update a locker's service state (enable/disable for maintenance).

Mark out of service:
Administratively disable a locker for maintenance or due to hardware failure.
Locker becomes unavailable for new transactions. Existing transactions are
preserved but may not be openable if hardware has failed.

Set outOfService: true with reasonCode and reason fields.

Return to service:
Re-enable a locker that was previously marked out of service. Locker becomes
available for new transactions if operational and not assigned.

Set outOfService: false. The reasonCode and reason fields are optional
and will be cleared if not provided.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

API Key

Add parameter in header

X-Session-Token

Example:

X-Session-Token: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Locker service state updated successfully

Body

🟠400Bad Request

🟠404Not Found

🟠409Conflict

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/lockers/' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "outOfService": true,
    "reasonCode": "MANUAL_DISABLE",
    "reason": "string"
}'

Response Example

200 - Example 1

{
    "success": true
}

Modified at 2025-11-27 00:06:25

Adjust locker count for controller

Refresh network information