Auction APIs
List of auction lots
| HTTP method | GET |
| URI | https://api.rambase.net/auction/lots?search={search}&inProductClassificationId={inPCId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 50 |
| Successful HTTP status code | 200 |
| API resource identifier | 432, version 19 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| search String, optional | A full-text search in lot descriptions. If search word is a number, matches for lot number and year and catalog edition is also performed. |
| inProductClassificationId String, optional | Filter the list to only contain lots classified in provided product classification or any of its children. If you don't want to include the classifications children, use $filter on ProductClassification. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| AuctionId Integer | Auction identifier. |
| AuctionType String | Type of auction. |
| Availability String | Availability of the lot. If empty, this lot is available.. |
| BiddingPeriodEndAt Datetime | End time of bidding on this lot. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| BiddingPeriodStartAt Datetime | Start time of bidding. Can be earlier than podium start time. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| BiddingPeriodStartWeek Integer | Planned week for bidding start. |
| Condition String | Condition of the lot. |
| Currency String | Three character code following the ISO 4217 standard. |
| CurrentBidPrice Decimal | Current bid/price. |
| EstimatedPrice Decimal | Appraisal/estimation of price. |
| LotId Integer | Lot identifier. |
| LotNumber Integer | Lot number in auction catalog. |
| Name String | Name/title/short description of lot. |
| NumberOfBids Integer | Current number of bids for this lot. |
| PodiumBiddingEstimatedAt Datetime | Estimated start time of podium bidding. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| PodiumBiddingStarted Boolean | True if lot has been on poduium, and bidding is started. |
| ProductCatalogItemNumber Integer | The item number the product has in the catalog. |
| ProductCatalogName String | Catalog the lot can be found in. |
| ProductClassificationId String | Product classification identifier. |
| StartingBidPrice Decimal | The lowest opening bid that will be accepted. |
| Status Integer | Status of lot. 1: Draft, 2: Prepared for auction, but not scheduled, 3: Scheduled for auction, 4: Available for bidding, 5: Sold, 6: Not sold, needs attention, 7: Sold and confirmed, 9: Completed. Either sold and paid, returned to supplier or moved to a different auction. |
| SupplierId Integer | RamBase supplier identifier. |
| Year Integer | Year of origin. |
Read more about filters and sorting on how to use sortable parameters
| AuctionId Integer | Auction identifier |
| AuctionType String | Type of auction |
| Availability String | Availability of the lot. If empty, this lot is available. |
| BiddingPeriodEndAt Datetime | End time of bidding on this lot |
| BiddingPeriodStartAt Datetime | Start time of bidding. Can be earlier than podium start time. |
| BiddingPeriodStartWeek Integer | Planned week for bidding start |
| Condition String | Condition of the lot |
| Currency String | Three character code following the ISO 4217 standard |
| CurrentBidPrice Decimal | Current bid/price |
| EstimatedPrice Decimal | Appraisal/estimation of price |
| LotId Integer | Lot identifier |
| LotNumber Integer | Lot number in auction catalog |
| Name String | Name/title/short description of lot |
| NumberOfBids Integer | Current number of bids for this lot |
| PodiumBiddingEstimatedAt Datetime | Estimated start time of podium bidding |
| PodiumBiddingStarted Boolean | True if lot has been on poduium, and bidding is started |
| ProductCatalogItemNumber Integer | The item number the product has in the catalog |
| ProductCatalogName String | Catalog the lot can be found in |
| ProductClassificationId String | Product classification identifier |
| StartingBidPrice Decimal | The lowest opening bid that will be accepted. |
| Status Integer | Status of lot. 1: Draft, 2: Prepared for auction, but not scheduled, 3: Scheduled for auction, 4: Available for bidding, 5: Sold, 6: Not sold, needs attention, 7: Sold and confirmed, 9: Completed. Either sold and paid, returned to supplier or moved to a different auction |
| SupplierId Integer | RamBase supplier identifier |
| Year Integer | Year of origin |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
LotId
Lot identifier
>{Integer}</LotId>Status
Status of lot.
1: Draft,
2: Prepared for auction, but not scheduled,
3: Scheduled for auction,
4: Available for bidding,
5: Sold,
6: Not sold, needs attention,
7: Sold and confirmed,
9: Completed. Either sold and paid, returned to supplier or moved to a different auction
Possible domain values can be found here
>{Integer}</Status>Name
Name/title/short description of lot
>{String}</Name>LotNumber
Lot number in auction catalog
>{Integer}</LotNumber>Condition
Condition of the lot
>{String}</Condition>Year
Year of origin
>{Integer}</Year>Description
Description of the lot
>{String}</Description>NumberOfBids
Current number of bids for this lot
>{Integer}</NumberOfBids>PodiumBiddingStarted
True if lot has been on poduium, and bidding is started
>{Boolean}</PodiumBiddingStarted>Availability
Availability of the lot. If empty, this lot is available.
Possible domain values can be found here
>{String}</Availability>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>StartingBid
The lowest opening bid that will be accepted.
>{Decimal}</StartingBid>CurrentBid
Current bid/price
>{Decimal}</CurrentBid>Estimated
Appraisal/estimation of price
>{Decimal}</Estimated>StartAt
Start time of bidding. Can be earlier than podium start time.
>{Datetime}</StartAt>PodiumBiddingEstimatedAt
Estimated start time of podium bidding
>{Datetime}</PodiumBiddingEstimatedAt>EndAt
End time of bidding on this lot
>{Datetime}</EndAt>MainImage
Main image of lot. Other images can be found in the details view.
>FileVersionId
File identifier
>{String}</FileVersionId>FileVersionLink
File reference
>{String}</FileVersionLink>Name
Catalog the lot can be found in
>{String}</Name>ItemNumber
The item number the product has in the catalog
>{Integer}</ItemNumber>ProductId
Product identifier
>{Integer}</ProductId>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>ProductLink
Product reference
>{String}</ProductLink>Supplier
The supplier/owner/seller of the lot.
>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Database
Database of the object
>{String}</Database>SupplierLink
Supplier reference
>{String}</SupplierLink>AuctionId
Auction identifier
>{Integer}</AuctionId>AuctionLink
Auction reference
>{String}</AuctionLink>LotLink
Lot reference
>{String}</LotLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>LotId
Lot identifier
": "{Integer}",Status
Status of lot.
1: Draft,
2: Prepared for auction, but not scheduled,
3: Scheduled for auction,
4: Available for bidding,
5: Sold,
6: Not sold, needs attention,
7: Sold and confirmed,
9: Completed. Either sold and paid, returned to supplier or moved to a different auction
Possible domain values can be found here
": "{Integer}",Name
Name/title/short description of lot
": "{String}",LotNumber
Lot number in auction catalog
": "{Integer}",Condition
Condition of the lot
": "{String}",Year
Year of origin
": "{Integer}",Description
Description of the lot
": "{String}",NumberOfBids
Current number of bids for this lot
": "{Integer}",PodiumBiddingStarted
True if lot has been on poduium, and bidding is started
": "{Boolean}",Availability
Availability of the lot. If empty, this lot is available.
Possible domain values can be found here
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",StartingBid
The lowest opening bid that will be accepted.
": "{Decimal}",CurrentBid
Current bid/price
": "{Decimal}",Estimated
Appraisal/estimation of price
": "{Decimal}"StartAt
Start time of bidding. Can be earlier than podium start time.
": "{Datetime}",PodiumBiddingEstimatedAt
Estimated start time of podium bidding
": "{Datetime}",EndAt
End time of bidding on this lot
": "{Datetime}"MainImage
Main image of lot. Other images can be found in the details view.
": {FileVersionId
File identifier
": "{String}",FileVersionLink
File reference
": "{String}"Name
Catalog the lot can be found in
": "{String}",ItemNumber
The item number the product has in the catalog
": "{Integer}"ProductId
Product identifier
": "{Integer}",ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"ProductLink
Product reference
": "{String}"Supplier
The supplier/owner/seller of the lot.
": {SupplierId
RamBase supplier identifier
": "{Integer}",Database
Database of the object
": "{String}",SupplierLink
Supplier reference
": "{String}"AuctionId
Auction identifier
": "{Integer}",Type
Type of auction
Possible domain values can be found here
": "{String}",AuctionLink
Auction reference
": "{String}"LotLink
Lot reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100567 HTTP 400 | The company does not have the module {0} |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 101087 HTTP 400 | Description argument/result mismatch |