Lots

Lots

Lots.

Constructor

new Lots()

Source:

Methods

close(lotId, state) → {Promise.<JsonApiResponse>}

Close the lot.

Source:
Parameters:
Name Type Description
lotId string

ID of the lot.
state string

New lot state.
Returns:
Type:
Promise.<JsonApiResponse>

create(lot) → {Promise.<JsonApiResponse>}

Create a lot. Creation might need approval depending on the account type.

Source:
Parameters:
Name Type Description
lot object

Lot data.

Name Type Attributes Description
type string

Lot type.
currency string

Lot currency.
startPrice string

Start price in lot currency.
deposit string <optional>

Desired deposit amount in lot currency.
buyNowPrice string <optional>

"Buy Now" price in lot currency.
minStep string <optional>

Minimal bid increment in lot currency. For 'eng' auctions only.
maxStep string <optional>

Maximal bid increment in lot currency. For 'eng' auctions only.
startTime number <optional>

Auction start time. Unix timestamp in seconds.
duration number <optional>

Auction duration. In seconds.
details object <optional>

Lot details.
Returns:
Type:
Promise.<JsonApiResponse>

createCallback(lotId) → {JsonApiResponse}

Create a callback request

Source:
Parameters:
Name Type Description
lotId String

ID of the lot
Returns:
Type:
JsonApiResponse

deleteCallback(lotId, accountIdopt) → {JsonApiResponse}

Delete a callback request

Source:
Parameters:
Name Type Attributes Default Description
lotId String

ID of the lot
accountId string <optional>
 null

Account ID of the user.
Returns:
Type:
JsonApiResponse

get(lotId, queryopt) → {JsonApiResponse}

Get lot by ID.

Source:
Parameters:
Name Type Attributes Description
lotId string

ID of the lot.
query object <optional>

Request options.

Name Type Attributes Description
include object <optional>

Include resources associated with the lot.
Returns:
Type:
JsonApiResponse

getBidRequests(queryopt) → {JsonApiResponse}

Get the lot bid requests.

Source:
Parameters:
Name Type Attributes Description
query object <optional>

Request options.

Name Type Attributes Description
page.number Number <optional>

Page number.
page.size Number <optional>

Page size.
sort Array.<string> <optional>

Sorting params.
requestor string <optional>

Requestor of the request.
reviewer reviewer <optional>

Reviewer of the request.
Returns:
Type:
JsonApiResponse

getCount(queryopt) → {JsonApiResponse}

Get lots count.

Source:
Parameters:
Name Type Attributes Description
query object <optional>

Request options.
Returns:
Type:
JsonApiResponse

getMessages(queryopt) → {JsonApiResponse}

Get messages associated with the lot.

Source:
Parameters:
Name Type Attributes Description
query object <optional>

Request options.

Name Type Attributes Description
page.number Number <optional>

Page number.
page.size Number <optional>

Page size.
sort Array.<string> <optional>

Sorting params.
Returns:
Type:
JsonApiResponse

getPage(queryopt) → {JsonApiResponse}

Get lots.

Source:
Parameters:
Name Type Attributes Description
query object <optional>

Request options.

Name Type Attributes Description
page.number Number <optional>

Page number.
page.size Number <optional>

Page size.
sort Array.<string> <optional>

Sorting params.
Returns:
Type:
JsonApiResponse

getParticipants(queryopt) → {JsonApiResponse}

Get lot participants.

Source:
Parameters:
Name Type Attributes Description
query object <optional>

Request options.

Name Type Attributes Description
page.number Number <optional>

Page number.
page.size Number <optional>

Page size.
sort Array.<string> <optional>

Sorting params.
Returns:
Type:
JsonApiResponse

getParticipationRequests(queryopt) → {JsonApiResponse}

Get the lot participation requests.

Source:
Parameters:
Name Type Attributes Description
query object <optional>

Request options.

Name Type Attributes Description
page.number Number <optional>

Page number.
page.size Number <optional>

Page size.
sort Array.<string> <optional>

Sorting params.
requestor string <optional>

Requestor of the request.
reviewer reviewer <optional>

Reviewer of the request.
Returns:
Type:
JsonApiResponse

participate(lotId, buyNowopt) → {Promise.<JsonApiResponse>}

Participate in auction or sale.

Source:
Parameters:
Name Type Attributes Default Description
lotId string

ID of the lot.
buyNow boolean <optional>
 false

Request "Buy Now" if true.
Returns:
Type:
Promise.<JsonApiResponse>

rejectParticipant(lotId, participantId) → {Promise.<JsonApiResponse>}

Manage auction participant.

Source:
Parameters:
Name Type Description
lotId string

ID of the lot.
participantId string

ID of the participant to be rejected.
Returns:
Type:
Promise.<JsonApiResponse>

requestBuyNow(lotId, participantId) → {Promise.<JsonApiResponse>}

Request "buy now" for a lot.

Source:
Parameters:
Name Type Description
lotId string

ID of the lot.
participantId string

ID of the participant to request "Buy Now" for.
Returns:
Type:
Promise.<JsonApiResponse>

setWinner(lotId, participantId, buyNowopt) → {Promise.<JsonApiResponse>}

Set the winner.

Source:
Parameters:
Name Type Attributes Default Description
lotId string

ID of the lot.
participantId string

ID of the winner.
buyNow boolean <optional>
 false

Is 'buy now' winner.
Returns:
Type:
Promise.<JsonApiResponse>

setWinnerDetails(lotId, details)

Set lot winner details

Source:
Parameters:
Name Type Description
lotId String
details Object
Name Type Attributes Description
invoiceId String <optional>
invoicePaid Boolean <optional>
containerId String <optional>
serviceLink String <optional>
feeAmount Number <optional>
transportationFee Number <optional>
feeCurrency String <optional>
totalAmount Number <optional>

submitBid(lotId, amount) → {Promise.<JsonApiResponse>}

Submit a bid.

Source:
Parameters:
Name Type Description
lotId string

ID of the lot.
amount string

Bid amount in lot currency.
Returns:
Type:
Promise.<JsonApiResponse>