Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Keep typing  - a search needs at least two characters

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Reservation Exchanges / Create Exchange

  • Article
  • 4 minutes to read

Operation Information

Creates a Ricoh Locker click-and-collect exchange for a machine.

This is a Free Tier Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Ricoh.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Ricoh in the Type pick list;
  • Give the Ricoh KeySafe key a Title (this is the name / identifier for the Ricoh account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Tenant string Ricoh Tenant
Username string Authentication Username
Endpoint string Ricoh API Endpoint
Password string Authentication Password
Access Token string Ricoh Access Token this will be updated aumatically and does not need to be manually filled.

Tip

To connect to Ricoh, you will need to input your username and password for your Ricoh account.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Ricoh account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Machine ID machineId string The identifier of the Ricoh Locker machine for this exchange. Yes None provided
Start Date Time startDateTime string The exchange start date and time. This must be in the following format ‘YYYY-MM-DD HH:MM:SS’. Yes None provided
End Date Time endDateTime string The exchange end date and time. This must be in the following format ‘YYYY-MM-DD HH:MM:SS’. Yes None provided
End User ID endUserId integer The Ricoh end-user ID for the exchange. Yes None provided
Agent ID agentId integer The Ricoh agent ID associated with the exchange. Yes None provided
Cell Size cellSize string The required cell size for the exchange. Yes S, M, L, XL, XXL
Easy Access Required isEasyAccessRequired boolean Whether the exchange requires an easy-access cell. No None provided
Item Is Heavy isItemHeavy boolean Whether the item is considered heavy. No None provided
Reason reason string The reason for the exchange. Yes DEFECTIVE, BROKEN, WRONG, UNWANTED
Notes notes string Optional notes for the exchange. No None provided
Items items array Optional items included in the exchange. No None provided

Output Parameters

Display Name ID Type Description
Status status string The operation outcome — ok or failed.
Error error string Error detail if the operation failed.
Start Date Time startDateTime string The exchange start date and time.
End Date Time endDateTime string The exchange end date and time.
End User ID endUserId integer The associated end-user ID.
Agent ID agentId integer The associated agent ID.
Cell Size cellSize string The requested cell size.
Easy Access Required isEasyAccessRequired boolean Whether an easy-access cell was required.
Item Is Heavy isItemHeavy boolean Whether the item was marked as heavy.
Reason reason string The exchange reason.
Notes notes string Exchange notes.
Items items string JSON string containing the exchange items.
Exchange ID id integer The created exchange ID.
Created At createdAt string When the exchange was created.
State state string The exchange state.
Delivery Cell ID deliveryCellId string The identifier of the delivery cell.
Delivery Cell Box ID deliveryCellBoxId integer The box ID of the delivery cell.
Return Cell ID returnCellId string The identifier of the return cell.
Return Cell Box ID returnCellBoxId integer The box ID of the return cell.
Delivery State deliveryState string The delivery state.
Return State returnState string The return state.
Delivery Dropped Off At deliveryDroppedOffAt string When the delivery was dropped off.
Delivery Picked Up At deliveryPickedUpAt string When the delivery was picked up.
Return Dropped Off At returnDroppedOffAt string When the return was dropped off.
Return Picked Up At returnPickedUpAt string When the return was picked up.
Drop-Off Code dropOffCode string The exchange drop-off code.
Pick-Up Code pickUpCode string The exchange pick-up code.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document