Auction APIs

GET auction/lots/{lotId}/bids/{bidId}

Bid details for provided identifier

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

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:

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:

                                        <Bid>
                                    

<BidId

BidId

Bid identifier

>{Integer}</BidId>

<BidStatus

BidStatus

Status of the bid

>{Integer}</BidStatus>

<Type

Type

Type of bid

Possible domain values can be found here

>{String}</Type>

<CreatedAt

CreatedAt

Timestamp of the bid

>{Datetime}</CreatedAt>

<Currency

Currency

Three character code following the ISO 4217 standard

>{String}</Currency>

<AppliedAmount

AppliedAmount

The amount applied for the bid (lower or equal to maximum amount)

>{Decimal}</AppliedAmount>

<MaximumAmount

MaximumAmount

The highest amount the bidder is willing to spend for this lot. The amount will increase according to the bid increment setup.

>{Decimal}</MaximumAmount>

                                             <Customer>
                                    

<CustomerId

CustomerId

Customer identifier

>{Integer}</CustomerId>

<Name

Name

Name of customer (name of company or surname/familyname/lastname of a person)

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

>{String}</Name>

<Firstname

Firstname

Secondary name of a company or firstname of a person

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

>{String}</Firstname>

<CustomerLink

CustomerLink

Customer reference

>{String}</CustomerLink>

                                             </Customer>
                                    

                                             <SalesOrderItem>
                                    

<Database

Database

Company code/database the object belongs to

>{String}</Database>

<SalesOrderId

SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>

<SalesOrderLink

SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>

<ItemId

ItemId

Sales order item identifier

>{Integer}</ItemId>

<ItemLink

ItemLink

Reference to the sales order item.

>{String}</ItemLink>

                                             </SalesOrderItem>
                                    

                                             <Bidder>
                                    

<ObjectId

ObjectId

The person placing the bid. Either a contact related to the customer, or an employee

>{Integer}</ObjectId>

<ObjectType

ObjectType

The person placing the bid. Either a contact related to the customer, or an employee

>{String}</ObjectType>

<ObjectLink

ObjectLink

The person placing the bid. Either a contact related to the customer, or an employee

>{String}</ObjectLink>

                                             </Bidder>
                                    

<Comment

Comment

Comment/note for the bid

>{String}</Comment>

<IsHighestBid

IsHighestBid

True if the bid is the highest/leading bid

>{Boolean}</IsHighestBid>

                                        </Bid>
                                    

{

                                             "bid": {
                                    

"bidId

BidId

Bid identifier

": "{Integer}",

"bidStatus

BidStatus

Status of the bid

": "{Integer}",

"type

Type

Type of bid

Possible domain values can be found here

": "{String}",

"createdAt

CreatedAt

Timestamp of the bid

": "{Datetime}",

"currency

Currency

Three character code following the ISO 4217 standard

": "{String}",

"appliedAmount

AppliedAmount

The amount applied for the bid (lower or equal to maximum amount)

": "{Decimal}",

"maximumAmount

MaximumAmount

The highest amount the bidder is willing to spend for this lot. The amount will increase according to the bid increment setup.

": "{Decimal}",

                                                  "customer": {
                                    

"customerId

CustomerId

Customer identifier

": "{Integer}",

"name

Name

Name of customer (name of company or surname/familyname/lastname of a person)

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

": "{String}",

"firstname

Firstname

Secondary name of a company or firstname of a person

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

": "{String}",

"customerLink

CustomerLink

Customer reference

": "{String}"

},

                                                  "salesOrderItem": {
                                    

"database

Database

Company code/database the object belongs to

": "{String}",

"salesOrderId

SalesOrderId

Sales order identifier

": "{Integer}",

"salesOrderLink

SalesOrderLink

Sales order reference

": "{String}",

"itemId

ItemId

Sales order item identifier

": "{Integer}",

"itemLink

ItemLink

Reference to the sales order item.

": "{String}"

},

                                                  "bidder": {
                                    

"objectId

ObjectId

The person placing the bid. Either a contact related to the customer, or an employee

": "{Integer}",

"objectType

ObjectType

The person placing the bid. Either a contact related to the customer, or an employee

": "{String}",

"objectLink

ObjectLink

The person placing the bid. Either a contact related to the customer, or an employee

": "{String}"

},

"comment

Comment

Comment/note for the bid

": "{String}",

"isHighestBid

IsHighestBid

True if the bid is the highest/leading bid

": "{Boolean}"

}

}

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 100933 HTTP 400

Bid not found