Class: CatalogItem

CatalogItem(dataopt)

Represents a Catalog Item.

Constructor

new CatalogItem(dataopt)

Create a new instance of a Catalog Item
Parameters:
Name Type Attributes Description
data object <optional>
Data typically returned from an API response.
Source:

Classes

CatalogItem

Members

alternate_no :string

Type:
  • string
Source:

category_id :number

Type:
  • number
Source:

description :string

Type:
  • string
Source:

dim_x :string

Type:
  • string
Source:

dim_y :string

Type:
  • string
Source:

dim_z :string

Type:
  • string
Source:

image_url :string

Type:
  • string
Source:

is_obsolete :boolean

Type:
  • boolean
Source:

language_code :string

Type:
  • string
Source:

name :string

Type:
  • string
Source:

no :string

Type:
  • string
Source:

thumbnail_url :string

Type:
  • string
Source:

type :string

Type:
  • string
Source:

weight :number

Type:
  • number
Source:

year_released :string

Type:
  • string
Source:

Methods

(static) get(itemType, itemNumber) → {BricklinkRequest}

Method to get a known catalog item Usage: ``` var req = CatalogItem.get(ItemType.Part, '3001'); client.send(req).then(item => console.log(item)); ```
Parameters:
Name Type Description
itemType string Catalog item type i.e. - MINIFIG, PART, SET, BOOK, GEAR, CATALOG, INSTRUCTION, UNSORTED_LOT, ORIGINAL_BOX
itemNumber string Catalog item number
Source:
Returns:
A request that is ready to execute with a client.
Type
BricklinkRequest