API

Auction APIs

GET auction/lots/{lotId}

Lot details for provided identifier

HTTP method GET
URI https://api.rambase.net/auction/lots/{lotId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {lotId} Lot identifier
Integer, minimum 100
Successful HTTP status code 200
API resource identifier 481, version 12

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.

$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

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
<Lot>
2
     <LotId
LotId

Lot identifier

>{Integer}</LotId>
3
     <LotNumber
LotNumber

Lot number in auction catalog

>{Integer}</LotNumber>
4
     <Name
Name

Name/title/short description of lot

>{String}</Name>
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

>{Integer}</Status>
6
     <Condition
Condition

Condition of the lot

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

Year of origin

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

Description of the lot

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

Current number of bids for this lot

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

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

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

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

Possible domain values can be found here

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

Three character code following the ISO 4217 standard

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

The lowest opening bid that will be accepted.

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

Current bid/price

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

Appraisal/estimation of price

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

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

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

Estimated start time of podium bidding

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

End time of bidding on this lot

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

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

>
24
          <FileVersionId
FileVersionId

File identifier

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

File reference

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

Catalog the lot can be found in

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

The item number the product has in the catalog

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

Product identifier

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

Product classification identifier

>{String}</ProductClassificationId>
35
               <TreeLevel
TreeLevel

Level in product classification tree (0 is root)

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

>{Integer}</TreeLevel>
36
               <Name
Name

Name of product classification

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

>{String}</Name>
37
               <ProductClassificationLink
ProductClassificationLink

Product classification reference

>{String}</ProductClassificationLink>
38
          </ProductClassification>
39
          <ParentProductClassifications
ParentProductClassifications

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

>
40
               <ParentProductClassification
ParentProductClassification

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

>
41
                    <ProductClassificationId
ProductClassificationId

Product classification identifier

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

>{Integer}</ProductClassificationId>
42
                    <TreeLevel
TreeLevel

Level in product classification tree (0 is root)

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

>{Integer}</TreeLevel>
43
                    <Name
Name

Name of product classification

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

>{String}</Name>
44
                    <ProductClassificationLink
ProductClassificationLink

Product classification reference

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

>{String}</ProductClassificationLink>
45
               </ParentProductClassification>
46
          </ParentProductClassifications>
47
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
48
     </Product>
49
     <Supplier
Supplier

The supplier/owner/seller of the lot.

>
50
          <SupplierId
SupplierId

RamBase supplier identifier

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

Database of the object

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

Supplier reference

>{String}</SupplierLink>
53
     </Supplier>
54
     <Auction>
55
          <AuctionId
AuctionId

Auction identifier

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

Type of auction

Possible domain values can be found here

>{String}</Type>
57
          <IsAvailableExternal
IsAvailableExternal

Tells whether the auciton is visible public (ex. online) or not.

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

>{Boolean}</IsAvailableExternal>
58
          <AuctionLink
AuctionLink

Auction reference

>{String}</AuctionLink>
59
     </Auction>
60
</Lot>
1
{
2
     "lot": {
3
          "lotId
LotId

Lot identifier

": "{Integer}",
4
          "lotNumber
LotNumber

Lot number in auction catalog

": "{Integer}",
5
          "name
Name

Name/title/short description of lot

": "{String}",
6
          "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

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

Condition of the lot

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

Year of origin

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

Description of the lot

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

Current number of bids for this lot

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

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

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

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

Possible domain values can be found here

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

Three character code following the ISO 4217 standard

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

The lowest opening bid that will be accepted.

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

Current bid/price

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

Appraisal/estimation of price

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

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

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

Estimated start time of podium bidding

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

End time of bidding on this lot

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

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

": {
25
               "fileVersionId
FileVersionId

File identifier

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

File reference

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

Catalog the lot can be found in

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

The item number the product has in the catalog

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

Product identifier

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

Product classification identifier

": "{String}",
36
                    "treeLevel
TreeLevel

Level in product classification tree (0 is root)

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

": "{Integer}",
37
                    "name
Name

Name of product classification

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

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

Product classification reference

": "{String}"
39
               },
40
               "parentProductClassifications
ParentProductClassifications

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

": [
41
                    {
42
                         "productClassificationId
ProductClassificationId

Product classification identifier

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

": "{Integer}",
43
                         "treeLevel
TreeLevel

Level in product classification tree (0 is root)

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

": "{Integer}",
44
                         "name
Name

Name of product classification

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

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

Product classification reference

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

": "{String}"
46
                    }
47
               ],
48
               "productLink
ProductLink

Product reference

": "{String}"
49
          },
50
          "supplier
Supplier

The supplier/owner/seller of the lot.

": {
51
               "supplierId
SupplierId

RamBase supplier identifier

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

Database of the object

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

Supplier reference

": "{String}"
54
          },
55
          "auction": {
56
               "auctionId
AuctionId

Auction identifier

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

Type of auction

Possible domain values can be found here

": "{String}",
58
               "isAvailableExternal
IsAvailableExternal

Tells whether the auciton is visible public (ex. online) or not.

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

": "{Boolean}",
59
               "auctionLink
AuctionLink

Auction reference

": "{String}"
60
          }
61
     }
62
}

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 100209 HTTP 400 Illegal document Id {0}
Error 101086 HTTP 400 Missing required argument {0} for description
Error 101087 HTTP 400 Description argument/result mismatch