Merchant Search Diamonds

POST

api

diamonds

merchant_search

curl --request POST \
  --url https://api-staging.unbridaled.ai/api/v2/diamonds/merchant_search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {
    "shape": [
      "asscher",
      "princess",
      "oval",
      "pear",
      "round",
      "radiant",
      "cushion",
      "emerald",
      "marquise"
    ],
    "price_min": 1,
    "price_max": 10000,
    "weight_min": 0,
    "weight_max": 2,
    "color": [
      "E",
      "I",
      "D",
      "G",
      "F",
      "H",
      "J"
    ],
    "clarity": [
      "SI1",
      "VS1",
      "VVS1",
      "IF",
      "VVS2",
      "SI2",
      "VS2",
      "FL"
    ],
    "polish_grade": [
      "VG",
      "EX",
      "G",
      "F"
    ],
    "cut_grade": [
      "VG",
      "EX",
      "G"
    ],
    "fluorescence": [
      "None",
      "Faint",
      "Medium",
      "Strong",
      "Very Strong"
    ],
    "symmetry_grade": [
      "VG",
      "EX",
      "G",
      "F"
    ],
    "depth_percentage_min": 0,
    "depth_percentage_max": 100,
    "table_min": 0,
    "table_max": 10000,
    "type": [
      "mined",
      "lab grown"
    ]
  },
  "limit": 100,
  "offset": 10,
  "sort_col": "retail_price",
  "sort_order": "asc"
}'

{}

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

filters

object

filters.sku

string[]

List of gem skus

filters.lab

enum<string>[]

List of gem lab

Available options:

GIA,

IGI,

GCAL

filters.cert_num

string[]

List of gem cert num

filters.shape

enum<string>[]

List of gem shapes

Available options:

asscher,

baguette,

briolette,

bullets,

calf,

cushion,

emerald,

half_moon,

heart,

hexagon,

lozenge,

marquise,

octagon,

oval,

pear,

princess,

radiant,

rectangle,

round,

shield,

tapered_baguette,

trapezoid,

triangle

filters.memo

boolean

Whether to only search for gems that can be memoed

filters.has_media

boolean

Whether to only search for gems that have valid media

filters.retail_price_min

integer

Minimum retail price

filters.retail_price_max

integer

Maximum retail price

filters.weight_min

number

Minimum carat weight

filters.weight_max

number

Maximum carat weight

filters.color

enum<string>[]

List of gem color values

Available options:

D,

E,

F,

G,

H,

I,

J,

K,

L,

M,

N,

O,

OP,

P,

Q,

QR,

R,

S,

ST,

T,

U,

UV,

V,

W,

WX,

X,

Y,

YZ,

Z

filters.clarity

enum<string>[]

List of clarity values

Available options:

FL,

IF,

VVS1,

VVS2,

VS1,

VS2,

SI1,

SI2,

I1,

I2,

I3

filters.cut_grade

enum<string>[]

List of possible cut grades

Available options:

IDL,

EX,

VG,

G,

F,

P,

None

filters.polish_grade

enum<string>[]

Polish grades of the gem

Available options:

EX,

VG,

G,

F,

P

filters.fluorescence

enum<string>[]

Fluorescence levels of the gem

Available options:

Very Strong,

Strong,

Medium,

Faint,

Slight,

Very Slight,

None,

filters.symmetry_grade

enum<string>[]

Symmetry grades of the gem

Available options:

EX,

VG,

G,

F,

P

filters.depth_percentage_min

number

Minimum depth percentage

filters.depth_percentage_max

number

Maximum depth percentage

filters.table_percantage_min

number

Minimum table percentage

filters.table_percantage_max

number

Maximum table percentage

filters.ratio_max

number

Maximum ratio of length:width

filters.ratio_min

number

Minimum ratio of length:width

filters.type

enum<string>[]

Type of the gem (mined or lab grown)

Available options:

mined,

lab grown

filters.delivery_days_min

integer

Minimum number of delivery days for shipping

filters.delivery_days_max

integer

Maximum number of delivery days for shipping

filters.cut_code_shape

string[]

List of cut code and shape combo for filtering. This value should be created by joining the cut_code and shape using ':'. For example princess:rose_cut

limit

integer

offset

integer

sort_col

string

sort_order

string

Response

200 - application/json

The response is of type object.

Is In Stock

curl --request POST \
  --url https://api-staging.unbridaled.ai/api/v2/diamonds/merchant_search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {
    "shape": [
      "asscher",
      "princess",
      "oval",
      "pear",
      "round",
      "radiant",
      "cushion",
      "emerald",
      "marquise"
    ],
    "price_min": 1,
    "price_max": 10000,
    "weight_min": 0,
    "weight_max": 2,
    "color": [
      "E",
      "I",
      "D",
      "G",
      "F",
      "H",
      "J"
    ],
    "clarity": [
      "SI1",
      "VS1",
      "VVS1",
      "IF",
      "VVS2",
      "SI2",
      "VS2",
      "FL"
    ],
    "polish_grade": [
      "VG",
      "EX",
      "G",
      "F"
    ],
    "cut_grade": [
      "VG",
      "EX",
      "G"
    ],
    "fluorescence": [
      "None",
      "Faint",
      "Medium",
      "Strong",
      "Very Strong"
    ],
    "symmetry_grade": [
      "VG",
      "EX",
      "G",
      "F"
    ],
    "depth_percentage_min": 0,
    "depth_percentage_max": 100,
    "table_min": 0,
    "table_max": 10000,
    "type": [
      "mined",
      "lab grown"
    ]
  },
  "limit": 100,
  "offset": 10,
  "sort_col": "retail_price",
  "sort_order": "asc"
}'

{}

Diamonds

Inventory

Orders

Merchant Templates

Profit Margins

Defaults

Authorizations

Body

Response