Auction APIs

GET auction/lots/{lotId}/bids

List of all bids of the specified lot. Note that this resource not filter on logged in customer/supplier.

HTTP method	GET
URI	https://api.rambase.net/auction/lots/{lotId}/bids
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {lotId}	Lot identifier Integer, minimum 100000
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	1822, version 9

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
$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.

AppliedAmount Decimal	The amount applied for the bid (lower or equal to maximum amount).
Bidder. ObjectId Integer	The person placing the bid. Either a contact related to the customer, or an employee.
Bidder. ObjectType String	The person placing the bid. Either a contact related to the customer, or an employee.
BidId Integer	Bid identifier.
BidStatus Integer	Status of the bid.
Comment String	Comment/note for the bid.
CreatedAt Datetime	Timestamp of the bid. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Customer. CustomerId Integer	Customer identifier.
IsHighestBid Boolean	True if the bid is the highest/leading bid.
MaximumAmount Decimal	The highest amount the bidder is willing to spend for this lot. The amount will increase according to the bid increment setup.
SalesOrderItem. Database String	Company code/database the object belongs to.
SalesOrderItem. ItemId Integer	Sales order item identifier.
SalesOrderItem. SalesOrderId Integer	Sales order identifier.
Type String	Type of bid.

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

AppliedAmount Decimal	The amount applied for the bid (lower or equal to maximum amount)
Bidder. ObjectId Integer	The person placing the bid. Either a contact related to the customer, or an employee
Bidder. ObjectType String	The person placing the bid. Either a contact related to the customer, or an employee
BidId Integer	Bid identifier
BidStatus Integer	Status of the bid
Comment String	Comment/note for the bid
CreatedAt Datetime	Timestamp of the bid
Customer. CustomerId Integer	Customer identifier
IsHighestBid Boolean	True if the bid is the highest/leading bid
MaximumAmount Decimal	The highest amount the bidder is willing to spend for this lot. The amount will increase according to the bid increment setup.
SalesOrderItem. Database String	Company code/database the object belongs to
SalesOrderItem. ItemId Integer	Sales order item identifier
SalesOrderItem. SalesOrderId Integer	Sales order identifier
Type String	Type of bid

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:

                                        <Bids>
                                    

                                             <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=Bid.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=Bid.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>

<Lastname

Lastname

Lastname of the bidder

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

>{String}</Lastname>

<Firstname

Firstname

Firstname of the bidder

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

>{String}</Firstname>

<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>

<BidLink

BidLink

Reference to the bid

>{String}</BidLink>

                                             </Bid>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

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

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<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>

<FirstPage

FirstPage

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

>{String}</FirstPage>

<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>

<PreviousPage

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

>{String}</PreviousPage>

<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>

<NextPage

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

>{String}</NextPage>

<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>

<LastPage

LastPage

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

>{String}</LastPage>

<Size

Size

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

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Bids>
                                    

{

                                             "bids": [
                                    

{

"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=Bid.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=Bid.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}",

"lastname

Lastname

Lastname of the bidder

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

": "{String}",

"firstname

Firstname

Firstname of the bidder

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

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

"bidLink

BidLink

Reference to the bid

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

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

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"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}",

"firstPage

FirstPage

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

": "{String}",

"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}",

"previousPage

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

": "{String}",

"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}",

"nextPage

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

": "{String}",

"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}",

"lastPage

LastPage

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

": "{String}",

"size

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 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