Listing object

Seller API v1 · Updated 7 November 2026

A listing as the API returns it. When you create or update one, send the fields in the table.

Fields

FieldTypeDescription
item_typestringset, minifig, part, gear or book, with item_no in klodivo numbers (6080-1, 3001). Or use bricklink_type (S, M, P, I, O, G, B) and bricklink_no.
color_idintegerParts: the colour. Or bricklink_color_id.
kindstringSets only: item, instructions or box.
statestringnew or used.
gradestringUsed items: like_new, good or acceptable.
completenessstringSets, instructions and boxes: sealed, complete or incomplete.
has_boxbooleanComes with its box.
has_instructionsbooleanComes with its instructions.
notesstringShown to buyers, up to 500 characters. Required for a used set.
quantityinteger0 to 99,999. 0 marks it sold out.
pricestringPrice per unit in your store's currency, like "12.50".
statusstringactive or hidden.
external_refstringYour own id for the listing, up to 64 characters.
Was this helpful?

Still stuck? Contact us; we reply within 2 business days.