> ## Documentation Index
> Fetch the complete documentation index at: https://developers.unbridaled.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Melee Parcel Filters

> List the in-stock melee diamond parcels of a given shape and type as a nested filter tree.

Only parcels with `quantity > 0` are returned. Prices are the merchant's wholesale prices: the US wholesale price list for US merchants and the default wholesale price list otherwise.

## Returns

A `filters` object nested five levels deep — `shape` → `cut_code` → `type` → `size` → `quality` — where each leaf is the parcel.

- `size` is the stone length for `round` parcels (e.g. `"1.3"`) and `"{length} x {width}"` for every other shape (e.g. `"3.5 x 2.75"`), in millimeters, formatted to one or two decimals.
- `quality` is `"{color_max}-{color}/{clarity_max}-{clarity}"` (e.g. `"F-D/VS2-VS1"`) — the color and clarity range of the stones in the parcel.



## OpenAPI

````yaml get /api/v3/diamonds/get_parcel_filters
openapi: 3.1.0
info:
  title: Unbridaled Marketplace Merchant API v3
  description: Developer API to integrate with Unbridaled Marketplace (v3)
  version: 3.0.0
servers:
  - url: https://api-staging.unbridaled.ai
    description: Sandbox API
  - description: Production API
    url: https://api.unbridaled.ai
security:
  - apikeyAuth: []
tags:
  - name: Diamonds
  - name: Gemstones
  - name: Inventory
  - name: Orders
  - name: Product Variants
  - name: Products
  - name: Merchant Templates
  - name: Merchant Addresses
  - name: Profit Margins
  - name: Defaults
paths:
  /api/v3/diamonds/get_parcel_filters:
    get:
      tags:
        - Diamonds
      summary: Get Melee Parcel Filters
      description: >-
        List the in-stock melee diamond parcels of a given shape and type as a
        nested filter tree.


        Only parcels with `quantity > 0` are returned. Prices are the merchant's
        wholesale prices: the US wholesale price list for US merchants and the
        default wholesale price list otherwise.


        ## Returns


        A `filters` object nested five levels deep — `shape` → `cut_code` →
        `type` → `size` → `quality` — where each leaf is the parcel.


        - `size` is the stone length for `round` parcels (e.g. `"1.3"`) and
        `"{length} x {width}"` for every other shape (e.g. `"3.5 x 2.75"`), in
        millimeters, formatted to one or two decimals.

        - `quality` is `"{color_max}-{color}/{clarity_max}-{clarity}"` (e.g.
        `"F-D/VS2-VS1"`) — the color and clarity range of the stones in the
        parcel.
      parameters:
        - name: shape
          in: query
          required: false
          schema:
            type: string
            default: round
          description: >-
            Shape of the melee parcels to list. Defaults to `round`. See `Get
            Default Gem Attributes` for the supported values.
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - mined
              - lab grown
            default: mined
          description: Type of the melee parcels to list. Defaults to `mined`.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  filters:
                    type: object
                    description: Melee parcels keyed by shape.
                    additionalProperties:
                      type: object
                      description: Keyed by cut code, e.g. `brilliant_cut`.
                      additionalProperties:
                        type: object
                        description: Keyed by type, `mined` or `lab grown`.
                        additionalProperties:
                          type: object
                          description: >-
                            Keyed by size in millimeters — length for round
                            parcels, `length x width` otherwise.
                          additionalProperties:
                            type: object
                            description: >-
                              Keyed by quality,
                              `{color_max}-{color}/{clarity_max}-{clarity}`.
                            additionalProperties:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  description: Internal identifier of the parcel.
                                sku:
                                  type: string
                                  description: >-
                                    SKU to use when placing an order for this
                                    parcel.
                                product_type:
                                  type: string
                                  description: Always `melee` for this endpoint.
                                type:
                                  type: string
                                  description: '`mined` or `lab grown`.'
                                stone_type:
                                  type: string
                                  nullable: true
                                  description: Always `null` for melee diamonds.
                                quality:
                                  type: string
                                  description: >-
                                    Same value as the `quality` key of this
                                    leaf.
                                quantity:
                                  type: number
                                  description: Number of stones available in the parcel.
                                weight:
                                  type: number
                                  description: Weight of a single stone, in carats.
                                wholesale_price:
                                  type: number
                                  description: Wholesale price per carat, in USD.
                                wholesale_price_per_ct:
                                  type: number
                                  description: >-
                                    Same as `wholesale_price`; melee is priced
                                    per carat.
                                tolerance_positive:
                                  type: number
                                  nullable: true
                                  description: >-
                                    Upper size tolerance of the parcel, in
                                    millimeters.
                                tolerance_negative:
                                  type: number
                                  nullable: true
                                  description: >-
                                    Lower size tolerance of the parcel, in
                                    millimeters.
                                days_to_return:
                                  type: integer
                                  nullable: true
                                  description: Days the merchant has to return the parcel.
                                memo_days_to_return:
                                  type: integer
                                  nullable: true
                                  description: >-
                                    Days to return when the parcel is taken on
                                    memo.
                                internal_days_to_return:
                                  type: integer
                                  nullable: true
                                  description: >-
                                    Days Unbridaled has to return the parcel to
                                    its supplier.
                                delivery_days_min:
                                  type: integer
                                  nullable: true
                                  description: Minimum delivery time in business days.
                                delivery_days_max:
                                  type: integer
                                  nullable: true
                                  description: Maximum delivery time in business days.
                                shape_icon_url:
                                  type: string
                                  nullable: true
                                  description: URL of the shape icon (SVG).
                                shape_image_url:
                                  type: string
                                  nullable: true
                                  description: URL of the shape image (PNG).
                                ux_url:
                                  type: string
                                  nullable: true
                                  description: >-
                                    URL of the 360 viewer, when media is
                                    available.
                                cached_ux_url:
                                  type: string
                                  nullable: true
                                  description: Cached 360 viewer URL, when available.
                                v360_json_base_url:
                                  type: string
                                  nullable: true
                                  description: Base URL of the 360 frame assets.
                                v360_info:
                                  type: object
                                  nullable: true
                                  description: >-
                                    360 media metadata (`frame_count`,
                                    `s3_path`, `md5_hash`, `image_ext`).
                                is_sustainable:
                                  type: boolean
                                  nullable: true
                                  description: >-
                                    Whether the parcel is flagged as
                                    sustainable.
                                sustainability_details:
                                  type: object
                                  nullable: true
                                  description: Sustainability attributes, when set.
              example:
                filters:
                  round:
                    brilliant_cut:
                      mined:
                        '1.3':
                          F-D/VS2-VS1:
                            id: 909651
                            sku: UB-MELEE-1
                            product_type: melee
                            type: mined
                            stone_type: null
                            quality: F-D/VS2-VS1
                            quantity: 25
                            weight: 0.01
                            wholesale_price: 150
                            wholesale_price_per_ct: 150
                            tolerance_positive: 0.05
                            tolerance_negative: 0.05
                            days_to_return: 0
                            memo_days_to_return: 0
                            internal_days_to_return: 0
                            delivery_days_min: 1
                            delivery_days_max: 2
                            shape_icon_url: >-
                              https://unbridaled-dev.s3.amazonaws.com/das/static/images/shape_icons/shape-round.svg
                            shape_image_url: >-
                              https://unbridaled-dev.s3.amazonaws.com/das/static/images/shape_images/brilliant-round.png
                            ux_url: ''
                            cached_ux_url: null
                            v360_json_base_url: null
                            v360_info: null
                            is_sustainable: false
                            sustainability_details: null
        '401':
          description: >-
            Missing or invalid token, or API access is not enabled for the
            merchant.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: API is not enabled for this merchant.
        '403':
          description: Token type is not allowed on this endpoint.
        '422':
          description: Invalid `shape` or `type` value.
components:
  securitySchemes:
    apikeyAuth:
      type: http
      scheme: bearer

````