List Merchant Templates

curl --request GET \
  --url https://api-staging.unbridaled.ai/api/v3/merchant_templates/list \
  --header 'Authorization: Bearer <token>'

{
  "merchant_templates": [
    {
      "uuid": "DEFAULT_IDEAL",
      "merchant_uuid": null,
      "group": "DEFAULT",
      "position": 1,
      "label": "IDEAL",
      "color": "F",
      "clarity": "VS1",
      "grade_name": "ideal",
      "order": null
    },
    {
      "uuid": "DEFAULT_PREMIUM",
      "merchant_uuid": null,
      "group": "DEFAULT",
      "position": 2,
      "label": "PREMIUM",
      "color": "H",
      "clarity": "VS2",
      "grade_name": "excellent",
      "order": null
    },
    {
      "uuid": "DEFAULT_STANDARD",
      "merchant_uuid": null,
      "group": "DEFAULT",
      "position": 3,
      "label": "STANDARD",
      "color": "I",
      "clarity": "SI1",
      "grade_name": "very good",
      "order": null
    }
  ],
  "total": 3,
  "offset": 0,
  "limit": 100
}

Merchant Templates

List Merchant Templates

Retrieve a paginated 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.

For more details on merchant templates and AI-curated results, refer to the documentation: AI Curated Results.

Returns

A paginated list of merchant template objects with total, offset, and limit.

GET

api

merchant_templates

list

List Merchant Templates

curl --request GET \
  --url https://api-staging.unbridaled.ai/api/v3/merchant_templates/list \
  --header 'Authorization: Bearer <token>'

{
  "merchant_templates": [
    {
      "uuid": "DEFAULT_IDEAL",
      "merchant_uuid": null,
      "group": "DEFAULT",
      "position": 1,
      "label": "IDEAL",
      "color": "F",
      "clarity": "VS1",
      "grade_name": "ideal",
      "order": null
    },
    {
      "uuid": "DEFAULT_PREMIUM",
      "merchant_uuid": null,
      "group": "DEFAULT",
      "position": 2,
      "label": "PREMIUM",
      "color": "H",
      "clarity": "VS2",
      "grade_name": "excellent",
      "order": null
    },
    {
      "uuid": "DEFAULT_STANDARD",
      "merchant_uuid": null,
      "group": "DEFAULT",
      "position": 3,
      "label": "STANDARD",
      "color": "I",
      "clarity": "SI1",
      "grade_name": "very good",
      "order": null
    }
  ],
  "total": 3,
  "offset": 0,
  "limit": 100
}

Authorizations

Authorization

string

header

required

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

Query Parameters

offset

integer

default:0

How many results to skip. Used for pagination. Defaults to 0.

limit

integer

default:100

How many results to return. Defaults to 100.

Response

200 - application/json

merchant_templates

object[]

Show child attributes

total

integer

offset

integer

limit

integer

Search Orders List Merchant Addresses