StorageTreasures Auction Integration

Documentation in support of external partners integrating with StorageTreasures via the Auction Import Service. This technical spec outlines the APIs available to developers for:

• Creating new auctions
• Cancellation requests for cancellation of auctions

Create auction and cancel auction are both fully supported at this time when using these APIs.

Create Auction(s)

This is the resource that will be consumed to create auctions via the Merlin API. The highlighted fields are required for Manual or Automatic Auction Activation.

AuctionableUnitInfo is an aggregate, and the system allows for multiple auctionableUnitInfo records in a single call (batch upload), for a single Facility. The system does not support uploading auction info for multiple Facilities in a single call.

When updating the list of auctionable units for a Facility, the entire list of auctionable units must be sent. Partial updates (deltas) are not supported at this time. This is because we use this list to remove a unit from the list of units available for Auction if it is no longer reflected in the list from the PMS.

If imageUrls are sent, the expectation is that this service will be coded to retrieve the images via those URLs. OpenTech Alliance provides an S3 bucket where the uploaded images are stored, as this provides the fastest performance for processing Auction Import Service uploads.

auctionType : Optional field with one of the following string values :

• Lien (Default if not sent)
• Non-Lien
• Charity

If auctionType is Charity for a facility that hasn’t enrolled in the Charity Auctions program in StorageTreasures, the auction will not be posted, will be put into a Pending status in Merlin, and a human will need to get involved to get the auction posted (because either the auctionType will need to be changed, or the facility will need to be enrolled into the Charity Auction program).

The StorageTreasures Support Team will get notifications that the auction is Pended and get involved. Knowing this constraint in advance, you can prevent it from impacting your business by getting the facilities enrolled in the Charity Auction program before sending Charity Auctions for processing.

POST /api/3/auctioninfo

Request

Response

Attributes

guid

required
Your Assigned Facility Id. Please Contact Opentech for your value. Unique client identifier for the unit. Limit: 20 Char Max length.
Example: "111e529c-67c8-4dfe-9a3a-f3659bcf2f2e"

string

required
Your Assigned Client Type. Please Contact OpenTech for your value.
Example: "SelfStoragePmsName"

object array

required
Contains an array of auctions to be created.

Cancel Auction

This endpoint allows you to cancel auctions.

If for some reason the unit auction can’t be cancelled - this API will return a negative-acknowledgement (NAK) with the error message in the response. The known reasons for a failed cancellation are:

1. The UnitId isn’t recognized in our system (Error)
2. The Unit’s auction Info identifies that the auction has already been cancelled (Warning)
3. The Unit’s auction Info identifies that the auction already closed as sold or unsold (Warning)

Even though cancelAuctionIds is an aggregate, the system only allows for a single unit cancellation per endpoint request. This is because we acknowledge (ACK) / NAK the entire transaction, and don’t have a way to reflect partial successes in our response. The prospect of batch processing is being reserved for future growth, but if multiple units are sent now the API will return an error with a message indicating that this API currently only supports one unit cancellation per endpoint request.

Attributes

guid

required
Your facility Id. Unique identifier for the unit.
Limit: 20 Char Max length.
Example: "111e529c-67c8-4dfe-9a3a-f3659bcf2f2e"

string

required
Your Assigned Client Type. Please Contact OpenTech for your value.
Example: "SelfStoragePmsName"

object array

required
Contains an array of auctions to be cancelled.

PUT /api/3/cancelauctions

Request

Response