Catalog

Get one engagement ring setting

Returns a single setting by its URL slug or SKU (AD-066 or bare 066). The response includes per-metal images and the platinum and two-tone upcharges, which is everything needed to describe the setting to a shopper; the center diamond is still priced separately.

get/api/v1/engagement-rings/{slug}

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/v1/engagement-rings/{slug}
  • Auth: one of:
    • none
    • API key in header X-Ada-Api-Key
    • OAuth 2 (authorization code, authorization URL https://www.adadiamonds.com/oauth/authorize, token URL https://www.adadiamonds.com/api/oauth/token; client credentials, token URL https://www.adadiamonds.com/api/oauth/token, scopes: catalog:read)

Path parameters

slugstring required

Product slug or SKU ("AD-066" or "066").

Response

The setting.

object'engagement_ring'
currency'USD'
price_notestring
skustring required
titlestring required
urlstring uri required
shapesstring[] required
stylestring nullable
typestring nullable
priceFromnumber nullable required

USD. Setting only; excludes the center diamond.

platinumUpchargenumber nullable

USD added for platinum.

twoToneUpchargenumber nullable

USD added for a two-tone setting.

Example response

{
  "sku": "AD-066",
  "images": [
    {
      "metal": "white"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.