API

Auction APIs

GET auction/lot-bids

List of all bids for all lots

HTTP method GET
URI https://api.rambase.net/auction/lot-bids
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 1825, version 7

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
$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).
AuctionId Integer Auction identifier.
BidderId Integer The person placing the bid. Either a contact related to the customer, or an employee.
BidderType 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()
CustomerId Integer Customer identifier.
IsHighestBid Boolean True if the bid is the highest/leading bid.
LotId Integer Lot identifier.
LotNumber Integer Lot number in auction catalog.
LotStatus 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.
MaximumAmount Decimal The highest amount the bidder is willing to spend for this lot. The amount will increase according to the bid increment setup.
SalesOrderId Integer Sales order identifier.
SalesOrderItemDatabase String Company code/database the object belongs to.
SalesOrderItemId Integer Sales order item 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)
AuctionId Integer Auction identifier
BidderId Integer The person placing the bid. Either a contact related to the customer, or an employee
BidderType 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
CustomerId Integer Customer identifier
IsHighestBid Boolean True if the bid is the highest/leading bid
LotId Integer Lot identifier
LotNumber Integer Lot number in auction catalog
LotStatus 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
MaximumAmount Decimal The highest amount the bidder is willing to spend for this lot. The amount will increase according to the bid increment setup.
SalesOrderId Integer Sales order identifier
SalesOrderItemDatabase String Company code/database the object belongs to
SalesOrderItemId Integer Sales order item 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:
1
<Bids>
2
     <Bid>
3
          <BidId
BidId

Bid identifier

>{Integer}</BidId>
4
          <BidStatus
BidStatus

Status of the bid

>{Integer}</BidStatus>
5
          <Type
Type

Type of bid

Possible domain values can be found here

>{String}</Type>
6
          <CreatedAt
CreatedAt

Timestamp of the bid

>{Datetime}</CreatedAt>
7
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
8
          <AppliedAmount
AppliedAmount

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

>{Decimal}</AppliedAmount>
9
          <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>
10
          <Comment
Comment

Comment/note for the bid

>{String}</Comment>
11
          <IsHighestBid
IsHighestBid

True if the bid is the highest/leading bid

>{Boolean}</IsHighestBid>
12
          <Lot>
13
               <LotId
LotId

Lot identifier

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

Lot number in auction catalog

>{Integer}</LotNumber>
15
               <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>
16
               <LotLink
LotLink

Lot reference

>{String}</LotLink>
17
          </Lot>
18
          <Bidder>
19
               <ObjectId
ObjectId

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

>{Integer}</ObjectId>
20
               <ObjectType
ObjectType

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

>{String}</ObjectType>
21
               <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>
22
               <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>
23
               <ObjectLink
ObjectLink

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

>{String}</ObjectLink>
24
          </Bidder>
25
          <Customer>
26
               <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
27
               <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>
28
               <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>
29
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
30
          </Customer>
31
          <SalesOrderItem>
32
               <Database
Database

Company code/database the object belongs to

>{String}</Database>
33
               <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
34
               <SalesOrderLink
SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>
35
               <ItemId
ItemId

Sales order item identifier

>{Integer}</ItemId>
36
               <ItemLink
ItemLink

Reference to the sales order item.

>{String}</ItemLink>
37
          </SalesOrderItem>
38
          <BidLink
BidLink

Reference to the bid

>{String}</BidLink>
39
     </Bid>
40
     <Paging
Paging

Detailed paging information for this list.

>
41
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
44
          <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>
45
          <FirstPage
FirstPage

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

>{String}</FirstPage>
46
          <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>
47
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
48
          <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>
49
          <NextPage
NextPage

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

>{String}</NextPage>
50
          <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>
51
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
53
     </Paging>
54
</Bids>
1
{
2
     "bids": [
3
          {
4
               "bidId
BidId

Bid identifier

": "{Integer}",
5
               "bidStatus
BidStatus

Status of the bid

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

Type of bid

Possible domain values can be found here

": "{String}",
7
               "createdAt
CreatedAt

Timestamp of the bid

": "{Datetime}",
8
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
9
               "appliedAmount
AppliedAmount

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

": "{Decimal}",
10
               "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}",
11
               "comment
Comment

Comment/note for the bid

": "{String}",
12
               "isHighestBid
IsHighestBid

True if the bid is the highest/leading bid

": "{Boolean}",
13
               "lot": {
14
                    "lotId
LotId

Lot identifier

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

Lot number in auction catalog

": "{Integer}",
16
                    "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}",
17
                    "lotLink
LotLink

Lot reference

": "{String}"
18
               },
19
               "bidder": {
20
                    "objectId
ObjectId

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

": "{Integer}",
21
                    "objectType
ObjectType

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

": "{String}",
22
                    "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}",
23
                    "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}",
24
                    "objectLink
ObjectLink

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

": "{String}"
25
               },
26
               "customer": {
27
                    "customerId
CustomerId

Customer identifier

": "{Integer}",
28
                    "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}",
29
                    "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}",
30
                    "customerLink
CustomerLink

Customer reference

": "{String}"
31
               },
32
               "salesOrderItem": {
33
                    "database
Database

Company code/database the object belongs to

": "{String}",
34
                    "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
35
                    "salesOrderLink
SalesOrderLink

Sales order reference

": "{String}",
36
                    "itemId
ItemId

Sales order item identifier

": "{Integer}",
37
                    "itemLink
ItemLink

Reference to the sales order item.

": "{String}"
38
               },
39
               "bidLink
BidLink

Reference to the bid

": "{String}"
40
          }
41
     ],
42
     "paging
Paging

Detailed paging information for this list.

": {
43
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
46
          "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}",
47
          "firstPage
FirstPage

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

": "{String}",
48
          "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}",
49
          "previousPage
PreviousPage

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

": "{String}",
50
          "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}",
51
          "nextPage
NextPage

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

": "{String}",
52
          "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}",
53
          "lastPage
LastPage

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

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

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

": "{Integer}"
55
     }
56
}

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