Sales APIs
List of auctions provided customer has participated in
| HTTP method | GET |
| URI | https://api.rambase.net/sales/customers/{customerId}/lot-bids/auctions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {customerId} |
Customer identifier
Integer, minimum 10000 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 5362, version 1 |
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.
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. |
| 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() |
| IsHighestBid Boolean | True if the bid is the highest/leading bid. |
| 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. |
| 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 |
| BidStatus Integer | Status of the bid |
| Comment String | Comment/note for the bid |
| CreatedAt Datetime | Timestamp of the bid |
| IsHighestBid Boolean | True if the bid is the highest/leading bid |
| 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 |
| 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.
AuctionId
Auction identifier
>{Integer}</AuctionId>Title
Title of auction
>{String}</Title>Description
Description of auction
>{String}</Description>AuctionLink
Auction reference
>{String}</AuctionLink>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NumberOfBids
Total number of lots the provided supplier is selling in this auction
>{Integer}</NumberOfBids>NumberOfHighestBids
Sum of starting bid prices for all lots the provided supplier is selling in this auction
>{Decimal}</NumberOfHighestBids>SumOfHighestBids
Sum of all lots estimated prices for provided supplier in this auction
>{Decimal}</SumOfHighestBids>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>AuctionId
Auction identifier
": "{Integer}",Status
Status of auction
Possible domain values can be found here
": "{Integer}",Type
Type of auction
Possible domain values can be found here
": "{String}",Title
Title of auction
": "{String}",Description
Description of auction
": "{String}",AuctionLink
Auction reference
": "{String}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NumberOfBids
Total number of lots the provided supplier is selling in this auction
": "{Integer}",NumberOfHighestBids
Sum of starting bid prices for all lots the provided supplier is selling in this auction
": "{Decimal}",SumOfHighestBids
Sum of all lots estimated prices for provided supplier in this auction
": "{Decimal}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",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 |