InventoryV2Lots

InventoryV2Lots

Inventory V2 lots.

Constructor

new InventoryV2Lots()

Source:

Methods

getById(opts) → {JsonApiResponse}

Get lot by its ID.

Source:
Parameters:
Name Type Attributes Description
opts object

Request opts.

Name Type Attributes Description
id string

Lot ID.

platformId string <optional>

Lot platform ID.

query object <optional>

Request query.

query.include Array.<string> | string <optional>

Included relationships. Available: stars

Returns:
Type:
JsonApiResponse

Lot response.

getCount(query, platformIdopt) → {JsonApiResponse}

Get overall count of currently active lots on specific platform.

Source:
Parameters:
Name Type Attributes Description
query object

Request query.

Name Type Attributes Description
page object <optional>

Query page params.

Name Type Attributes Description
cursor number <optional>

Page cursor.

limit number <optional>

Page limit.

sort string <optional>

Sort type (one of price, -price, end_time, created_at, -end_time, -created_at.

include Array.<string> | string <optional>

Included relationships. Available: stars

filter object <optional>

Query filter params.

Name Type Attributes Description
type string <optional>

Comma-separated lot types.

saleType string <optional>

Comma-separated sale types.

condition string <optional>

Vehicle condition.

maker string <optional>

Comma-separated vehicle makers.

model string <optional>

Comma-separated vehicle models.

yearFrom number <optional>

Minimum vehicle registration year.

yearTo number <optional>

Maximum vehicle registration year.

priceFrom number <optional>

Minimum vehicle price.

priceTo number <optional>

Maximum vehicle price.

country string <optional>

Comma-separated vehicle countries.

transmission string <optional>

Comma-separated vehicle transmissions.

fuelType string <optional>

Comma-separated vehicle fuel types.

engineVolumeFrom number <optional>

Minimum vehicle engine volume.

engineVolumeTo number <optional>

Maximum vehicle engine volume.

registered boolean <optional>

Sets whether vehicle is registered.

wheel string <optional>

Comma-separated vehicle wheels.

search string <optional>

Search value.

platformId string <optional>

Lots platform ID.

Returns:
Type:
JsonApiResponse

Lots count response.

getPage(query, platformIdopt) → {JsonApiResponse}

Get page of currently active lots on specific platform.

Source:
Parameters:
Name Type Attributes Description
query object

Request query.

Name Type Attributes Description
page object <optional>

Query page params.

Name Type Attributes Description
cursor number <optional>

Page cursor.

limit number <optional>

Page limit.

sort string <optional>

Sort type (one of price, -price, end_time, created_at, -end_time, -created_at.

include Array.<string> | string <optional>

Included relationships. Available: stars

filter object <optional>

Query filter params.

Name Type Attributes Description
type string <optional>

Comma-separated lot types.

saleType string <optional>

Comma-separated sale types.

condition string <optional>

Vehicle condition.

maker string <optional>

Comma-separated vehicle makers.

model string <optional>

Comma-separated vehicle models.

yearFrom number <optional>

Minimum vehicle registration year.

yearTo number <optional>

Maximum vehicle registration year.

priceFrom number <optional>

Minimum vehicle price.

priceTo number <optional>

Maximum vehicle price.

country string <optional>

Comma-separated vehicle countries.

transmission string <optional>

Comma-separated vehicle transmissions.

fuelType string <optional>

Comma-separated vehicle fuel types.

engineVolumeFrom number <optional>

Minimum vehicle engine volume.

engineVolumeTo number <optional>

Maximum vehicle engine volume.

registered boolean <optional>

Sets whether vehicle is registered.

wheel string <optional>

Comma-separated vehicle wheels.

organizerId string <optional>

Comma-separated organizerId.

search string <optional>

Search value.

platformId string <optional>

Lots platform ID.

Returns:
Type:
JsonApiResponse

Lots page response.