Constructor
new PriceGuide(dataopt)
Create a new instance of a price guide.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
data |
object |
<optional> |
Data returned from an API response. |
- Source:
Classes
Members
avg_price :number
Type:
- number
- Source:
currency_code :string
Type:
- string
- Source:
item :CatalogItem
item The item that belongs to the price guide.
Type:
- Source:
max_price :number
Type:
- number
- Source:
min_price :number
Type:
- number
- Source:
new_or_used :string
new_or_used Whether or not the price guide is new or used condition.
Type:
- string
- Source:
price_detail :Array.<PriceDetail>
Type:
- Array.<PriceDetail>
- Source:
qty_avg_price :number
Type:
- number
- Source:
total_quantity :number
Type:
- number
- Source:
unit_quantity :number
Type:
- number
- Source:
Methods
(static) get(itemType, itemNumber, paramsopt) → {BricklinkRequest}
Method to get a known catalog item's price guide
Usage:
```
var req = PriceGuide.get(ItemType.Part, '3001', {new_or_used: Condition.Used});
client.send(req).then(guide => console.log(guide));
```
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
itemType |
string | Catalog item type as found at ItemType. | |
itemNumber |
string | Catalog item number | |
params |
object |
<optional> |
Params as outlined in PriceGuideOptions. |
- Source:
Returns:
A request that is ready to execute with a client.
- Type
- BricklinkRequest