Auction APIs
Place a new bid for this lot. Note that if the bidder is a contact, is have to be related to the customer.
| HTTP method | POST |
| 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 |
| Successful HTTP status code | 201 |
| API resource identifier | 1823, 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.
Type
Required/mandatory field
Type of bid
Applicable domain values can be found here
>{String}</Type>Currency
Required/mandatory field
Three character code following the ISO 4217 standard
Applicable domain values can be found here
>{String}</Currency>MaximumAmount
Required/mandatory field
The highest amount the bidder is willing to spend for this lot. The amount will increase according to the bid increment setup.
Minimum value: 0
>{Decimal}</MaximumAmount>Customer
Required/mandatory field
The customer the bid is placed for
>CustomerId
Required/mandatory field
Customer identifier
Minimum value: 10000
>{Integer}</CustomerId>Bidder
Required/mandatory field
The person placing the bid. Either a contact related to the customer, or an employee
>ObjectId
Required/mandatory field
Identifier of the object
>{Integer}</ObjectId>ObjectType
Required/mandatory field
Type of object
>{String}</ObjectType>Type
Required/mandatory field
Type of bid
Applicable domain values can be found here
": "{String}",Currency
Required/mandatory field
Three character code following the ISO 4217 standard
Applicable domain values can be found here
": "{String}",MaximumAmount
Required/mandatory field
The highest amount the bidder is willing to spend for this lot. The amount will increase according to the bid increment setup.
Minimum value: 0
": "{Decimal}",Customer
Required/mandatory field
The customer the bid is placed for
": {CustomerId
Required/mandatory field
Customer identifier
Minimum value: 10000
": "{Integer}"Bidder
Required/mandatory field
The person placing the bid. Either a contact related to the customer, or an employee
": {ObjectId
Required/mandatory field
Identifier of the object
": "{Integer}",ObjectType
Required/mandatory field
Type of object
": "{String}"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.
| $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 |
| $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. |
| $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] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
BidId
Bid identifier
>{Integer}</BidId>BidStatus
Status of the bid
>{Integer}</BidStatus>CreatedAt
Timestamp of the bid
>{Datetime}</CreatedAt>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>AppliedAmount
The amount applied for the bid (lower or equal to maximum amount)
>{Decimal}</AppliedAmount>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>CustomerId
Customer identifier
>{Integer}</CustomerId>CustomerLink
Customer reference
>{String}</CustomerLink>Database
Company code/database the object belongs to
>{String}</Database>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>ItemId
Sales order item identifier
>{Integer}</ItemId>ItemLink
Reference to the sales order item.
>{String}</ItemLink>ObjectId
The person placing the bid. Either a contact related to the customer, or an employee
>{Integer}</ObjectId>ObjectType
The person placing the bid. Either a contact related to the customer, or an employee
>{String}</ObjectType>ObjectLink
The person placing the bid. Either a contact related to the customer, or an employee
>{String}</ObjectLink>Comment
Comment/note for the bid
>{String}</Comment>IsHighestBid
True if the bid is the highest/leading bid
>{Boolean}</IsHighestBid>BidId
Bid identifier
": "{Integer}",BidStatus
Status of the bid
": "{Integer}",Type
Type of bid
Possible domain values can be found here
": "{String}",CreatedAt
Timestamp of the bid
": "{Datetime}",Currency
Three character code following the ISO 4217 standard
": "{String}",AppliedAmount
The amount applied for the bid (lower or equal to maximum amount)
": "{Decimal}",MaximumAmount
The highest amount the bidder is willing to spend for this lot. The amount will increase according to the bid increment setup.
": "{Decimal}",CustomerId
Customer identifier
": "{Integer}",CustomerLink
Customer reference
": "{String}"Database
Company code/database the object belongs to
": "{String}",SalesOrderId
Sales order identifier
": "{Integer}",SalesOrderLink
Sales order reference
": "{String}",ItemId
Sales order item identifier
": "{Integer}",ItemLink
Reference to the sales order item.
": "{String}"ObjectId
The person placing the bid. Either a contact related to the customer, or an employee
": "{Integer}",ObjectType
The person placing the bid. Either a contact related to the customer, or an employee
": "{String}",ObjectLink
The person placing the bid. Either a contact related to the customer, or an employee
": "{String}"Comment
Comment/note for the bid
": "{String}",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 100041 HTTP 400 | Cannot delete this item |
| Error 106501 HTTP 400 | When using manufacturers product, globale trade item number must be updated there |
| Error 106502 HTTP 400 | When using manufacturers product, country of orgion country code must be updated there |
| Error 102941 HTTP 400 | Manufacturer is required |
| Error 103726 HTTP 400 | You can only set product as stock/non stock when status is equal to draft (status 1) |
| Error 103018 HTTP 400 | Name of product is required |
| Error 105833 HTTP 400 | CompanySetting require product name to be unique |
| Error 108872 HTTP 400 | The value {0} is not allowed to use in Type |
| Error 103548 HTTP 400 | DaysToExpediteScheduledStartDate can only be changed on product structures |
| Error 103550 HTTP 400 | IsManufacturedExternally can only be changed on product structures |
| Error 103551 HTTP 400 | IsManufacturedInBatches can only be changed on product structures |
| Error 103554 HTTP 400 | AutomaticallyCreateWorkOrdersForSubstructures can only be changed on product structures |
| Error 104253 HTTP 400 | ProduceInMultipleOf can only be changed on product structures. |
| Error 107694 HTTP 400 | Use line production can only be changed on product structeres |
| Error 106999 HTTP 400 | Sub module 'Projectorder' is not activated in this company |
| Error 106436 HTTP 400 | Unit can only be changed when status is equal to draft (status 1) |
| Error 100167 HTTP 404 | Measurement unit not found |
| Error 104486 HTTP 400 | Unit production is only allowed for measurment units (UNI) of type QTY |
| Error 100200 HTTP 404 | Special handling code not found |
| Error 100092 HTTP 404 | Service template not found |
| Error 103020 HTTP 404 | Qcdoc not found |
| Error 101091 HTTP 404 | Contry of origin is not valid: {0} |
| Error 101124 HTTP 400 | Hardware code already exists |
| Error 106437 HTTP 400 | Type can not be changed when status is not equal to draft (status 1) |
| Error 101009 HTTP 400 | The product has a structure. You can only change the product type to a type that can contain a structure. |
| Error 101010 HTTP 400 | The product structure contains operations and can not be changed to become a phantom structure |
| Error 101008 HTTP 400 | Cannot change product type from a physical type to a virtual type |
| Error 101007 HTTP 400 | Cannot change product type from a virtual type to a physical type |
| Error 103021 HTTP 400 | Linkid must be a rental product |
| Error 104760 HTTP 400 | Costing method can't be changed after product has been received |
| Error 104652 HTTP 400 | Both minimum sales price and minimum sales price currency must be given |
| Error 100563 HTTP 400 | Currency {0} is not supported by the system |
| Error 104653 HTTP 400 | Minimum sales price can not be negative |
| Error 106506 HTTP 404 | Image not found |