# Harbor Gateway

## Docs
- Root [How to Use Harbor Gateway Local API](https://docs.gateway.harborlockers.com/how-to-use-harbor-gateway-local-api-1814317m0.md): 
- Root [How to Use Harbor Gateway Cloud API](https://docs.gateway.harborlockers.com/how-to-use-harbor-gateway-cloud-api-2110574m0.md): 

## API Docs
- Root > Health & Status [Admin interface](https://docs.gateway.harborlockers.com/admin-interface-28385285e0.md): Serves the admin interface HTML frontend. This is the primary web interface for managing the locker service.
- Root > Health & Status [Health check](https://docs.gateway.harborlockers.com/health-check-28385286e0.md): Quick health check endpoint to verify the service is running
- Root > Transactions [List all transactions](https://docs.gateway.harborlockers.com/list-all-transactions-28385287e0.md): Retrieve all active transactions in the system
- Root > Transactions [Create a transaction](https://docs.gateway.harborlockers.com/create-a-transaction-28385288e0.md): Finds and assigns an available locker for the provided transactionId. Does not open the locker door - use the open endpoint separately when ready.
- Root > Transactions [Get transaction details](https://docs.gateway.harborlockers.com/get-transaction-details-28385289e0.md): Retrieve information about a specific transaction and its associated locker
- Root > Transactions [Release transaction](https://docs.gateway.harborlockers.com/release-transaction-28385290e0.md): Releases the transaction, disassociating it from the locker and marking the locker as available. Does not trigger any door operations.
- Root > Transactions [Open locker by transaction ID](https://docs.gateway.harborlockers.com/open-locker-by-transaction-id-28385291e0.md): Opens the locker associated with the transaction without disassociating it. Physical operation with 20-second timeout per attempt, up to 3 attempts with 1-second delays (maximum total time ~62 seconds). Retries occur on network/communication errors only; hardware malfunctions are not retried. Does not check outOfService or operational status (optimistic opening - useful for troubleshooting/maintenance).
- Root > Lockers [List all lockers](https://docs.gateway.harborlockers.com/list-all-lockers-28385292e0.md): Retrieve the status of all lockers in the system with optional filters
- Root > Lockers [Get locker configuration](https://docs.gateway.harborlockers.com/get-locker-configuration-28385293e0.md): Retrieve static configuration for all lockers without state information.
- Root > Lockers [Get locker details](https://docs.gateway.harborlockers.com/get-locker-details-28385294e0.md): Retrieve information about a specific locker
- Root > Lockers [Update locker service state](https://docs.gateway.harborlockers.com/update-locker-service-state-28385295e0.md): Update a locker's service state (enable/disable for maintenance, mark broken lock).
- Root > Lockers [Open locker by ID](https://docs.gateway.harborlockers.com/open-locker-by-id-28385296e0.md): Opens a specific locker by its ID. Physical operation with 20-second timeout per attempt, up to 3 attempts with 1-second delays (maximum total time ~62 seconds). Retries occur on network/communication errors only; hardware malfunctions are not retried. For maintenance use - does not check transaction status, outOfService, or operational status (optimistic opening - useful for troubleshooting/maintenance).
- Root > Lockers [Open all lockers](https://docs.gateway.harborlockers.com/open-all-lockers-28385297e0.md): Opens all lockers in the system. Each locker operation uses 20-second timeout per attempt, up to 3 attempts with 1-second delays between retries (maximum total time ~62 seconds per locker). Retries occur on network/communication errors only; hardware malfunctions are not retried. For maintenance/emergency use - does not check outOfService or operational status (optimistic opening).
- Root > Locker Types [List all locker types](https://docs.gateway.harborlockers.com/list-all-locker-types-28385298e0.md): Retrieve all defined locker types (physical dimensions and characteristics)
- Root > Locker Types [Get locker type details](https://docs.gateway.harborlockers.com/get-locker-type-details-28385299e0.md): Retrieve detailed information about a specific locker type
- Root > Bank Types [List all bank types](https://docs.gateway.harborlockers.com/list-all-bank-types-28385300e0.md): Retrieve all defined bank type configurations
- Root > Bank Types [Get bank type with associations](https://docs.gateway.harborlockers.com/get-bank-type-with-associations-28385301e0.md): Retrieve detailed bank type configuration including locker number to type mappings
- Root > System [Receive heartbeat from external device](https://docs.gateway.harborlockers.com/receive-heartbeat-from-external-device-28385302e0.md): Receive heartbeat from external devices to maintain operational status.
- Root > Meta [API version probe](https://docs.gateway.harborlockers.com/api-version-probe-34155914e0.md): Unauthenticated endpoint returning the current API version and status. Use to verify reachability before sending credentials.
- Root > Session [Identify the authenticated API key](https://docs.gateway.harborlockers.com/identify-the-authenticated-api-key-34155915e0.md): Returns the key's label, prefix, and the organization it's scoped to. Handy smoke test after provisioning a key.
- Root > Session [List locations accessible to this API key](https://docs.gateway.harborlockers.com/list-locations-accessible-to-this-api-key-34155916e0.md): Enumerates locations in the caller's organization, filtered by
- Root > Requests [Poll a pending request](https://docs.gateway.harborlockers.com/poll-a-pending-request-34155917e0.md): Returns the same shape as the original submission would have. When
- Root > Locations [Gateway health check](https://docs.gateway.harborlockers.com/gateway-health-check-34155918e0.md): Proxies the gateway's `GET /health`. Cheap, idempotent.
- Root > System [Gateway system info](https://docs.gateway.harborlockers.com/gateway-system-info-34155919e0.md): Proxies the gateway's `GET /system`. Hardware + firmware metadata.
- Root > Transactions [List transactions at a location](https://docs.gateway.harborlockers.com/list-transactions-at-a-location-34155920e0.md): 
- Root > Transactions [Create a transaction](https://docs.gateway.harborlockers.com/create-a-transaction-34155921e0.md): Creates a transaction at this location. The gateway assigns a locker
- Root > Transactions [Fetch a transaction](https://docs.gateway.harborlockers.com/fetch-a-transaction-34155922e0.md): 
- Root > Transactions [Release a transaction](https://docs.gateway.harborlockers.com/release-a-transaction-34155923e0.md): Releases the transaction, freeing its assigned locker and marking
- Root > Transactions [Open the locker assigned to a transaction](https://docs.gateway.harborlockers.com/open-the-locker-assigned-to-a-transaction-34155924e0.md): **Hardware operation.** Opens the physical locker door. Non-idempotent
- Root > Lockers [List lockers](https://docs.gateway.harborlockers.com/list-lockers-34155925e0.md): Lists lockers at a location, optionally filtered by state.
- Root > Lockers [Locker configuration](https://docs.gateway.harborlockers.com/locker-configuration-34155926e0.md): Returns the static configuration of lockers at this location. Safe to cache client-side.
- Root > Lockers [Fetch a locker](https://docs.gateway.harborlockers.com/fetch-a-locker-34155927e0.md): 
- Root > Lockers [Update a locker (e.g. out-of-service)](https://docs.gateway.harborlockers.com/update-a-locker-e-g-out-of-service-34155928e0.md): Partial update. Common use: toggle `outOfService` with a `reasonCode`
- Root > Lockers [Open a specific locker](https://docs.gateway.harborlockers.com/open-a-specific-locker-34155929e0.md): **Hardware operation. Non-idempotent.** Use `Idempotency-Key` for safe
- Root > Types [List locker types](https://docs.gateway.harborlockers.com/list-locker-types-34155930e0.md): 
- Root > Types [Fetch a locker type](https://docs.gateway.harborlockers.com/fetch-a-locker-type-34155931e0.md): 
- Root > Types [List bank types](https://docs.gateway.harborlockers.com/list-bank-types-34155932e0.md): 
- Root > Types [Fetch a bank type](https://docs.gateway.harborlockers.com/fetch-a-bank-type-34155933e0.md): 

## Schemas
- Root [Locker](https://docs.gateway.harborlockers.com/locker-11234081d0.md): 
- Root [LockerTypeSummary](https://docs.gateway.harborlockers.com/lockertypesummary-13016758d0.md): 
- Root [TransactionResponse](https://docs.gateway.harborlockers.com/transactionresponse-11234082d0.md): 
- Root [LockerType](https://docs.gateway.harborlockers.com/lockertype-13016759d0.md): 
- Root [LockController](https://docs.gateway.harborlockers.com/lockcontroller-11234083d0.md): 
- Root [LockerConfig](https://docs.gateway.harborlockers.com/lockerconfig-13016760d0.md): 
- Root [System](https://docs.gateway.harborlockers.com/system-11234084d0.md): 
- Root [LogEntry](https://docs.gateway.harborlockers.com/logentry-11234085d0.md): 
- Root [OperationResponse](https://docs.gateway.harborlockers.com/operationresponse-11234086d0.md): 
- Root [LockerOperationResponse](https://docs.gateway.harborlockers.com/lockeroperationresponse-11234087d0.md): 
- Root [MultiStatusOperationResponse](https://docs.gateway.harborlockers.com/multistatusoperationresponse-11234088d0.md): 
- Root [BankType](https://docs.gateway.harborlockers.com/banktype-13016761d0.md): 
- Root [OpenAllLockersResponse](https://docs.gateway.harborlockers.com/openalllockersresponse-11234089d0.md): 
- Root [BankTypeAssociation](https://docs.gateway.harborlockers.com/banktypeassociation-13016762d0.md): 
- Root [Error](https://docs.gateway.harborlockers.com/error-11234090d0.md): 
- Root [BankTypeWithAssociations](https://docs.gateway.harborlockers.com/banktypewithassociations-13016763d0.md): 
- Root [DeviceHeartbeatRequest](https://docs.gateway.harborlockers.com/deviceheartbeatrequest-13016764d0.md): 
- Root [ApiMeta](https://docs.gateway.harborlockers.com/apimeta-14542102d0.md): 
- Root [MeResponse](https://docs.gateway.harborlockers.com/meresponse-14542103d0.md): 
- Root [LocationSummary](https://docs.gateway.harborlockers.com/locationsummary-14542104d0.md): 
- Root [LocationList](https://docs.gateway.harborlockers.com/locationlist-14542105d0.md): 
- Root [PendingRequest](https://docs.gateway.harborlockers.com/pendingrequest-14542106d0.md): 
- Root [Error](https://docs.gateway.harborlockers.com/error-14542107d0.md): 
- Root [CreateTransactionBody](https://docs.gateway.harborlockers.com/createtransactionbody-14542108d0.md): 
- Root [PatchLockerBody](https://docs.gateway.harborlockers.com/patchlockerbody-14542109d0.md):