Catalog

Get one jewelry piece

Returns a single jewelry piece by URL slug or SKU. Use it to confirm a piece an agent found through listJewelry before presenting it, or to resolve a SKU a shopper quotes back.

get/api/v1/jewelry/{slug}

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/v1/jewelry/{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.

Response

The piece.

object'jewelry_item'
currency'USD'
skustring required
titlestring required
urlstring uri required
categorystring nullable
typestring nullable
subtypestring nullable
shapesstring[] required
priceFromnumber nullable required

USD.

priceMaxnumber nullable

USD.

Example response

{
  "images": [
    {
      "metal": "white"
    }
  ]
}

Changes

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