API

Auction APIs

GET auction/lots?search={search}&inProductClassificationId={inPCId}

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.

Format:
1
1

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.

Format:
1
<Lots>
2
     <Lot>
3
          <LotId
LotId

Lot identifier

>
{Integer}</LotId>
4
          <Status
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>
5
          <Name
Name

Name/title/short description of lot

>
{String}</Name>
6
          <LotNumber
LotNumber

Lot number in auction catalog

>
{Integer}</LotNumber>
7
          <Condition
Condition

Condition of the lot

>
{String}</Condition>
8
          <Year
Year

Year of origin

>
{Integer}</Year>
9
          <Description
Description

Description of the lot

>
{String}</Description>
10
          <NumberOfBids
NumberOfBids

Current number of bids for this lot

>
{Integer}</NumberOfBids>
11
          <PodiumBiddingStarted
PodiumBiddingStarted

True if lot has been on poduium, and bidding is started

>
{Boolean}</PodiumBiddingStarted>
12
          <Availability
Availability

Availability of the lot. If empty, this lot is available.

Possible domain values can be found here

>
{String}</Availability>
13
          <Price>
14
               <Currency
Currency

Three character code following the ISO 4217 standard

>
{String}</Currency>
15
               <StartingBid
StartingBid

The lowest opening bid that will be accepted.

>
{Decimal}</StartingBid>
16
               <CurrentBid
CurrentBid

Current bid/price

>
{Decimal}</CurrentBid>
17
               <Estimated
Estimated

Appraisal/estimation of price

>
{Decimal}</Estimated>
18
          </Price>
19
          <BiddingPeriod>
20
               <StartAt
StartAt

Start time of bidding. Can be earlier than podium start time.

>
{Datetime}</StartAt>
21
               <PodiumBiddingEstimatedAt
PodiumBiddingEstimatedAt

Estimated start time of podium bidding

>
{Datetime}</PodiumBiddingEstimatedAt>
22
               <EndAt
EndAt

End time of bidding on this lot

>
{Datetime}</EndAt>
23
          </BiddingPeriod>
24
          <MainImage
MainImage

Main image of lot. Other images can be found in the details view.

>
25
               <FileVersionId
FileVersionId

File identifier

>
{String}</FileVersionId>
26
               <FileVersionLink
FileVersionLink

File reference

>
{String}</FileVersionLink>
27
          </MainImage>
28
          <Catalog>
29
               <Name
Name

Catalog the lot can be found in

>
{String}</Name>
30
               <ItemNumber
ItemNumber

The item number the product has in the catalog

>
{Integer}</ItemNumber>
31
          </Catalog>
32
          <Product>
33
               <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
34
               <ProductClassification>
35
                    <ProductClassificationId
ProductClassificationId

Product classification identifier

>
{String}</ProductClassificationId>
36
                    <ProductClassificationLink
ProductClassificationLink

Product classification reference

>
{String}</ProductClassificationLink>
37
               </ProductClassification>
38
               <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
39
          </Product>
40
          <Supplier
Supplier

The supplier/owner/seller of the lot.

>
41
               <SupplierId
SupplierId

RamBase supplier identifier

>
{Integer}</SupplierId>
42
               <Database
Database

Database of the object

>
{String}</Database>
43
               <SupplierLink
SupplierLink

Supplier reference

>
{String}</SupplierLink>
44
          </Supplier>
45
          <Auction>
46
               <AuctionId
AuctionId

Auction identifier

>
{Integer}</AuctionId>
47
               <Type
Type

Type of auction

Possible domain values can be found here

>
{String}</Type>
48
               <AuctionLink
AuctionLink

Auction reference

>
{String}</AuctionLink>
49
          </Auction>
50
          <LotLink
LotLink

Lot reference

>
{String}</LotLink>
51
     </Lot>
52
     <Paging
Paging

Detailed paging information for this list.

>
53
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>
{Integer}</PageSize>
54
          <Position
Position

Position of the first element in the list

>
{Integer}</Position>
55
          <Page
Page

Page index

>
{Integer}</Page>
56
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</FirstPageKey>
57
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>
{String}</FirstPage>
58
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</PreviousPageKey>
59
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>
{String}</PreviousPage>
60
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</NextPageKey>
61
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>
{String}</NextPage>
62
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</LastPageKey>
63
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>
{String}</LastPage>
64
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>
{Integer}</Size>
65
     </Paging>
66
</Lots>
1
{
2
     "lots": [
3
          {
4
               "lotId
LotId

Lot identifier

":
"{Integer}",
5
               "status
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}",
6
               "name
Name

Name/title/short description of lot

":
"{String}",
7
               "lotNumber
LotNumber

Lot number in auction catalog

":
"{Integer}",
8
               "condition
Condition

Condition of the lot

":
"{String}",
9
               "year
Year

Year of origin

":
"{Integer}",
10
               "description
Description

Description of the lot

":
"{String}",
11
               "numberOfBids
NumberOfBids

Current number of bids for this lot

":
"{Integer}",
12
               "podiumBiddingStarted
PodiumBiddingStarted

True if lot has been on poduium, and bidding is started

":
"{Boolean}",
13
               "availability
Availability

Availability of the lot. If empty, this lot is available.

Possible domain values can be found here

":
"{String}",
14
               "price": {
15
                    "currency
Currency

Three character code following the ISO 4217 standard

":
"{String}",
16
                    "startingBid
StartingBid

The lowest opening bid that will be accepted.

":
"{Decimal}",
17
                    "currentBid
CurrentBid

Current bid/price

":
"{Decimal}",
18
                    "estimated
Estimated

Appraisal/estimation of price

":
"{Decimal}"
19
               },
20
               "biddingPeriod": {
21
                    "startAt
StartAt

Start time of bidding. Can be earlier than podium start time.

":
"{Datetime}",
22
                    "podiumBiddingEstimatedAt
PodiumBiddingEstimatedAt

Estimated start time of podium bidding

":
"{Datetime}",
23
                    "endAt
EndAt

End time of bidding on this lot

":
"{Datetime}"
24
               },
25
               "mainImage
MainImage

Main image of lot. Other images can be found in the details view.

":
{
26
                    "fileVersionId
FileVersionId

File identifier

":
"{String}",
27
                    "fileVersionLink
FileVersionLink

File reference

":
"{String}"
28
               },
29
               "catalog": {
30
                    "name
Name

Catalog the lot can be found in

":
"{String}",
31
                    "itemNumber
ItemNumber

The item number the product has in the catalog

":
"{Integer}"
32
               },
33
               "product": {
34
                    "productId
ProductId

Product identifier

":
"{Integer}",
35
                    "productClassification": {
36
                         "productClassificationId
ProductClassificationId

Product classification identifier

":
"{String}",
37
                         "productClassificationLink
ProductClassificationLink

Product classification reference

":
"{String}"
38
                    },
39
                    "productLink
ProductLink

Product reference

":
"{String}"
40
               },
41
               "supplier
Supplier

The supplier/owner/seller of the lot.

":
{
42
                    "supplierId
SupplierId

RamBase supplier identifier

":
"{Integer}",
43
                    "database
Database

Database of the object

":
"{String}",
44
                    "supplierLink
SupplierLink

Supplier reference

":
"{String}"
45
               },
46
               "auction": {
47
                    "auctionId
AuctionId

Auction identifier

":
"{Integer}",
48
                    "type
Type

Type of auction

Possible domain values can be found here

":
"{String}",
49
                    "auctionLink
AuctionLink

Auction reference

":
"{String}"
50
               },
51
               "lotLink
LotLink

Lot reference

":
"{String}"
52
          }
53
     ],
54
     "paging
Paging

Detailed paging information for this list.

":
{
55
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

":
"{Integer}",
56
          "position
Position

Position of the first element in the list

":
"{Integer}",
57
          "page
Page

Page index

":
"{Integer}",
58
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

":
"{String}",
59
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

":
"{String}",
60
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

":
"{String}",
61
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

":
"{String}",
62
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

":
"{String}",
63
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

":
"{String}",
64
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

":
"{String}",
65
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

":
"{String}",
66
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

":
"{Integer}"
67
     }
68
}

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