Is In Stock

apikeyAuth

Unbridaled Developer Hub

Developer Sandbox

Documentation

Community

API Reference

Dashboard

Support

Search the entire diamonds marketplace using filters.

Merchant Search Diamonds

Perform AI search using predefined merchant diamond templates. Each merchant template has a `group` to allow results from different templates from being returned at once. For example, you can create a `group` called `ai_solitaire` with `Standard`, `Premium` and `Ideal` templates if you plan to display the result together.

A `group` in the merchant template can roughly map to a `collection` of products in Shopify or other e-commerce platforms. This allows you to reuse different predefined templates easily for a `group` of products. Refer to `List Merchant Templates` API to learn about Merchant diamonds templates or check our tutorial to learn more about our AI merchant template concept here: [AI Curated Results](https://docs.unbridaled.ai/settings/ai-curated-results).

Diamonds AI Search

Place an order by specifying skus and quantities.

## Returns

Returns an `Order` object if successful.

Place Order

List Orders.

## Returns

An object with a `metadata` field containing pagination information, and an `orders` field containing a list of order objects.

List Orders

Search Orders. Request query parameters are similar to `ListOrders` with the addition of `?query=` to allow free text search in certain fields.

## Returns

An object with a "metadata" field containing pagination information, and an `orders` field containing a list of order objects.

Search Orders

Retrieve a list of merchant templates, including both predefined and default templates. Merchant templates define structured configurations for AI-powered diamond searches, allowing merchants to create curated diamond collections based on specific attributes.

Each template belongs to a `group`, which ensures that diamonds from different templates within the same group can be displayed together in search results. Groups function similarly to collections in e-commerce platforms like Shopify, making it easy to organize and reuse different predefined templates for a consistent shopping experience.

This endpoint is useful for merchants who want to retrieve their available AI-driven search templates and leverage groups to efficiently manage and customize their diamond offerings.

For more details on merchant templates and AI-curated results, refer to the documentation: [AI Curated Results](https://docs.unbridaled.ai/settings/ai-curated-results).

## Returns

A list of merchant template objects.


List Merchant Templates

Get profit margin according to profit_margin_uuid.

## Returns

A profit margin object.


Get Profit Margin

List all profit margins.

## Returns

A list of profit_margin objects.

List Profit Margins

Get Default Gem ratios. Requires any valid token

Get Default Gem Ratios

Get Default Gem Attributes

Get Default Profit Margins (currently all weight based).

Get Default Profit Margins

Get Default Collections for the bespoke collections on console. These values will be used with the `GetDiamondsByMerchant Template`. Requires any valid token.

Get Default Collections

Get Default Merchant Templates used by our AI when no custom Merchant Templates are present (`Merchant Template` is also known as `DiamondTemplate`). These values will be used with the `Diamonds AI Search` API.

Diamonds

Inventory

Orders

Merchant Templates

Profit Margins

Defaults

Is In Stock

Authorizations

Path Parameters

Response