Project

General

Profile

Catalog


Get Item

This method returns information about the specified item in BrickLink catalog.

Request

Method URI
GET /items/{type}/{no}

* Parameters

Parameter Name Value Optional Description
type String N The type of the item to get. Acceptable values are:
MINIFIG, PART, SET, BOOK, GEAR, CATALOG, INSTRUCTION, UNSORTED_LOT, ORIGINAL_BOX
no String N Identification number of the item to get

* Request body

Do not supply a request body with this method.
 

Response

If successful, this method returns a catalog item as "data" in the response body.

Example

  • GET /items/part/1234
    • Retrieves PART #1234
  • GET /items/set/1-1
    • Retrieves SET #1-1

Get Item Image

This method returns image URL of the specified item by colors.

Request

Method URI
GET /items/{type}/{no}/images/{color_id}

* Parameters

Parameter Name Value Optional Description
type String N The type of the item to get. Acceptable values are:
MINIFIG, PART, SET, BOOK, GEAR, CATALOG, INSTRUCTION, UNSORTED_LOT, ORIGINAL_BOX
no String N Identification number of the item to get
color_id Integer N

* Request body

Do not supply a request body with this method.
 

Response

If successful, this method returns a catalog item as "data" in the response body.
- thumbnail_url
- type
- no

Example


Get Supersets

This method returns a list of items that include the specified item.

Request

Method URI
GET /items/{type}/{no}/supersets

* Parameters

Parameter Name Value Optional Description
type String N The type of the item. Acceptable values are:
MINIFIG, PART, SET, BOOK, GEAR, CATALOG, INSTRUCTION, UNSORTED_LOT, ORIGINAL_BOX
no String N Identification number of the item
color_id Integer Y The color of the item

* Request body

Do not supply a request body with this method.
 

Response

If successful, this method returns a list of superset entries as "data" in the response body.

Example

  • GET /items/part/3001old/supersets
    • Retrieves a list of items that include the PART #3001old
  • GET /items/part/3001old/supersets?color_id=1
    • Retrieves a list of items that include the PART #3001old with color #1

Get Subsets

This method returns a list of items that are included in the specified item.

Request

Method URI
GET /items/{type}/{no}/subsets

* Parameters

Parameter Name Value Optional Description
type String N The type of the item. Acceptable values are:
MINIFIG, PART, SET, BOOK, GEAR, CATALOG, INSTRUCTION, UNSORTED_LOT, ORIGINAL_BOX
no String N Identification number of the item
color_id Integer Y The color of the item(This value is valid only for PART type)
box Boolean Y Indicates whether the set includes the original box
instruction Boolean Y Indicates whether the set includes the original instruction
break_minifigs Boolean Y Indicates whether the result breaks down minifigs as parts
break_subsets Boolean Y Indicates whether the result breaks down sets in set

* Request body

Do not supply a request body with this method.
 

Response

If successful, this method returns a nested list of subset entries as "data" in the response body. Note that the result is grouped by matching. An inner list indicates one matching group of items.

Example

  • GET /items/set/7644-1/subsets
    • Retrieves a list of items that are included in the SET #7644-1
  • GET /items/set/7644-1/subsets?instruction=true&break_minifigs=false
    • Retrieves a list of items that are included in the SET #7644-1 including the instruction and breaking down minifigs as parts

Get Price Guide

This method returns the price statistics of the specified item in BrickLink catalog. Note that returned price does not include VAT

Request

Method URI
GET /items/{type}/{no}/price

* Parameters

Parameter Name Value Optional Description
type String N The type of the item. Acceptable values are:
MINIFIG, PART, SET, BOOK, GEAR, CATALOG, INSTRUCTION, UNSORTED_LOT, ORIGINAL_BOX
no String N Identification number of the item
color_id Integer Y The color of the item
guide_type String Y Indicates that which statistics to be provided. Acceptable values are:
- "sold": Gets the price statistics of "Last 6 Months Sales"
- "stock": Gets the price statistics of "Current Items for Sale" (default)
new_or_used String Y Indicates the condition of items that are included in the statistics. Acceptable values are:
- "N": new item (default)
- "U": used item
country_code String Y The result includes only items in stores which are located in specified country.
- If you don't specify both country_code and region, this method retrieves the price information regardless of the store's location
region String Y The result includes only items in stores which are located in specified region.
- Available values are: asia, africa, north_america, south_america, middle_east, europe, eu, oceania
- If you don't specify both country_code and region, this method retrieves the price information regardless of the store's location
currency_code String Y This method returns price in the specified currency code
- If you don't specify this value, price is retrieved in the base currency of the user profile's
vat String Y Indicates that price will include VAT for the items of VAT enabled stores. Available values are:
- "N": Exclude VAT (default)
- "Y": Include VAT
- "O": Include VAT as Norway settings

* Request body

Do not supply a request body with this method.
 

Response

If successful, this method returns a price guide resource as "data" in the response body.

Example

  • GET /items/part/3001old/price
    • Retrieves price statistics(currently for sale) of PART #3001old in new condition
  • GET /items/part/3001old/price?new_or_used=U
    • Retrieves price statistics(currently for sale) of PART #3001old in used condition
  • GET /items/part/3001old/price?guide_type=sold
    • Retrieves price statistics(last 6 months sales) of PART #3001old in new condition
  • GET /items/part/3001old/price?guide_type=sold&country_code=US
    • Retrieves price statistics(last 6 months sales) of PART #3001old in new condition that are ordered from stores which are located in US.
  • GET /items/part/3001old/price?region=asia
    • Retrieves price statistics(currently for sale) of PART #3001old in new condition that are currently for sale in stores which are located in Asia.
  • GET /items/part/3001old/price?currency_code=USD
    • Retrieves price statistics(currently for sale in USD) of PART #3001old in new condition

Get Known Colors

This method returns currently known colors(ex: the column at the far right in this page) of the item

Request

Method URI
GET /items/{type}/{no}/colors

* Parameters

Do not supply a request parameter with this method.

* Request body

Do not supply a request body with this method.
 

Response

If successful, this method returns a list of known color as "data" in the response body.

Example


Add picture from clipboard (Maximum size: 24.4 MB)