Skip to main content
POST
Query Jewelry Products

Authorizations

Authorization
string
header
required

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

Body

application/json
q
string
id
string[]

Product ID(s) to filter by.

filter_variant_options
object

Jewelry attribute filters, e.g. {"jewelry_type": "Rings"}. See /api/v3/product_filters?product_type=jewelry for supported keys/values.

wholesale_price_min
number
wholesale_price_max
number
delivery_days_max
integer
order_by
string
default:updated_on

Column to sort by, or "category" to group by jewelry type/subtype.

order
enum<string>
default:desc
Available options:
asc,
desc
limit
integer
default:100
offset
integer
default:0
include_unavailable
boolean
default:false

Response

200 - application/json

OK

products
object[]
offset
integer
limit
integer
total
integer