Public Webcomponent

Search the store diamonds of an organization

Changed on

Filtered, paginated search over every diamond of the organization identified by the apikey header (all its groups). Prices are retail (markup applied). Public endpoint intended for embeddable webcomponents.

post/v3/public/webcomponent/diamond/search

Request

Headers

apikeystring required

Request body

shapesstring[] nullable
typesstring[] nullable
labsstring[] nullable

GIA, IGI, GCAL…

cutstring[] nullable
colorstring[] nullable
claritystring[] nullable
carat_minnumber nullable
carat_maxnumber nullable
price_minnumber nullable

Over the retail price

price_maxnumber nullable

Over the retail price

sort_mode'price-asc' | 'price-desc' | 'date-asc' | 'date-desc' | 'carat-asc' | 'carat-desc' | 'color-asc' | 'color-desc' nullable
pageinteger nullable
page_sizeinteger nullable

Response

Paginated diamonds with retail prices

totalinteger
pageinteger
page_sizeinteger
itemsobject[]

Changes