Resources
Auction Images
Images displayed when auctioning off a unit.
Generate the path for each image using the following pattern (spaces not allowed):
| !!! Disclaimer !!! Once an auction is active there is no mechanism to update or change the contents of an auction. Since people have already bid on it based on the description and existing images, we can't change the auction. To make changes we require to send a Cancel Auction request, wait no less than 15 minutes for the Cancel request to process, then call Create Auction with the new data and images. !!! Disclaimer !!! |
|---|
- Store all of the auction images for all of the units you are about to create auctions for to the S3 Bucket before proceeding.
- Create the request payload for all of the auction units in the facility including all of their image URLs you just used and successfully uploaded.
- Post the Create Auctions request with that payload.
- For subsequent Create Auctions requests, continue to send all the units for the facility if they are still auctions. The code is self-healing so it handles it correctly on our side (we ignore units that are active auctions, but create auctions if the unit is in the list but we don’t have an active auction).
Schema Objects
Schema objects are logical structures used when consuming service endpoints.
Categories
The StorageTreasures recognized categories are as follows.
Appliances
Books
Boxes
Cabinets & Shelves
Clothing & Shoes
Collectibles
Computers
Dishes & Kitchenware
Documents & Files
Electronics
Food & Beverages
Arms
Health & Wellness
Heavy Equipment
Household Furniture
Jewelry
Lamps
Mattress & Bedding
Memorabilia
Mirrors
Motor Vehicles & Parts
Movies, Music & Books
New Merchandise
Office Equipment
Old Stuff
Personal Effects
Sports & Outdoors
Tools & Supplies
Toys, Baby & Games
Wall Art
AuctionableUnitInfoRoot Object
The AuctionableUnitInfoRoot object contains all the information about the Auction, such as the unit, contents and tenant information.
Properties
string
optional
Facility Manager contact email address. Example: "[email protected]"
string
required
Unique identifier for the unit. Example: "123456789"
string
required
Unique name for the unit. Limit: 20 Char Max length. Example: "2316"
string
optional
Example: "5 X 10 Inside Non-Climate"
integer
required
Units in feet: 1-75
Example: 5
integer
required
Units in feet: 1-75
Example: 10
integer
optional
Units in feet: 0-75
Example: 10
timestamp
required
Must be UTC Time
Example: "2025-07-01T12:35:00.000Z"
timestamp
required
Must be UTC Time
Example: "2025-07-01T12:35:00.000Z"
string
optional
Example: "Lien"
decimal
required
Example: 230.20
string
optional
32 Characters Max Length
Example: "110385471-A"
string array
optional
Example: ["http://[S3_Bucket_Url]/[FileName1].jpg",
"http://[S3_Bucket_Url]/[FileName2].jpg"]
string
required
Must be less than 256 characters
Example: "Old library books"
string array
required
Example: [ "Appliances", "Books", "Lamps"]
string
optional
Must be less than 256 characters
string
optional
Example: "245610"
string
optional
Example: "Rick"
string
optional
Example: "Sanchez"
string
optional
Example: "2501 W Dunlap"
string
optional
Example: "Unit 256"
string
optional
Example: "Phoenix"
optional
Example: "AZ"
string
optional
Example: "85021"
string
optional
Example: "US"
AuctionableUnitInfoRoot
CancelAuctionIds Object
The CancelAuctionIds object contains basic information about the auction you wish to cancel.
Properties
string
required
Unique identifier for the unit.
Limit: 20 Char Max length.
Example: "2316"
string
required
Example: "A53-017"
integer
required
One of the following Integer values:
1 - AccountSettledWithTenant
2 - ErrorInLienProcessOrTimeline
3 - AuctionPostIncorrect
4 - Other (*)
Example: 4
string
optional
A human readable description of why the auction was cancelled. This value is required when the cancelReason is 4 (Other). This is for reporting purposes only. Example: "The reason this unit is being cancelled"
CancelAuctionIds