POST api/v2/gem/diamonds

Returns only natural certified diamonds

Request Information

URI Parameters

None.

Body Parameters

DiamondRequest
NameDescriptionTypeAdditional information
SerialNumbers

Collection of integer

None.

Clarity

Collection of DiamondClarityLookup

None.

Color

Collection of DiamondColorLookup

None.

FancyColors

Collection of string

None.

Polish

Collection of DiamondPolishLookup

None.

Shape

Collection of ShapeFilter

None.

Cut

Collection of DiamondCutLookup

None.

Certification

Collection of DiamondCertificationFilter

None.

Symmetry

Collection of DiamondSymmetryLookup

None.

Fluorescence

Collection of DiamondFluorescenceLookup

None.

SizeRange

Collection of decimal number

None.

PriceRange

Collection of decimal number

None.

DepthPercent

Collection of decimal number

None.

TablePercent

Collection of decimal number

None.

LengthToWidthRatio

Collection of decimal number

None.

GemOptions

Collection of GemOptions

None.

NextPage

string

None.

Page

integer

None.

PageSize

integer

None.

Request Formats

Sample:

{
  "SerialNumbers": [
    1,
    2
  ],
  "Clarity": [
    "IF",
    "IF"
  ],
  "Color": [
    "D",
    "D"
  ],
  "FancyColors": [
    "sample string 1",
    "sample string 2"
  ],
  "Polish": [
    "Ideal",
    "Ideal"
  ],
  "Shape": [
    "Round",
    "Round"
  ],
  "Cut": [
    "Ideal",
    "Ideal"
  ],
  "Certification": [
    "Stuller",
    "Stuller"
  ],
  "Symmetry": [
    "Ideal",
    "Ideal"
  ],
  "Fluorescence": [
    "VeryStrong",
    "VeryStrong"
  ],
  "SizeRange": [
    1.0,
    2.0
  ],
  "PriceRange": [
    1.1,
    2.1
  ],
  "DepthPercent": [
    1.0,
    2.0
  ],
  "TablePercent": [
    1.0,
    2.0
  ],
  "LengthToWidthRatio": [
    1.0,
    2.0
  ],
  "GemOptions": [
    {
      "Option": "SizeTypeCarat",
      "Value": "sample string 1"
    },
    {
      "Option": "SizeTypeCarat",
      "Value": "sample string 1"
    }
  ],
  "NextPage": "sample string 1",
  "Page": 1,
  "PageSize": 1
}

Sample:

<DiamondRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Certification>
    <DiamondCertificationFilter>Stuller</DiamondCertificationFilter>
    <DiamondCertificationFilter>Stuller</DiamondCertificationFilter>
  </Certification>
  <Clarity>
    <DiamondClarityLookup>IF</DiamondClarityLookup>
    <DiamondClarityLookup>IF</DiamondClarityLookup>
  </Clarity>
  <Color>
    <DiamondColorLookup>D</DiamondColorLookup>
    <DiamondColorLookup>D</DiamondColorLookup>
  </Color>
  <Cut>
    <DiamondCutLookup>Ideal</DiamondCutLookup>
    <DiamondCutLookup>Ideal</DiamondCutLookup>
  </Cut>
  <DepthPercent xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </DepthPercent>
  <FancyColors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FancyColors>
  <Fluorescence>
    <DiamondFluorescenceLookup>VeryStrong</DiamondFluorescenceLookup>
    <DiamondFluorescenceLookup>VeryStrong</DiamondFluorescenceLookup>
  </Fluorescence>
  <GemOptions>
    <GemOptions>
      <Option>SizeTypeCarat</Option>
      <Value>sample string 1</Value>
    </GemOptions>
    <GemOptions>
      <Option>SizeTypeCarat</Option>
      <Value>sample string 1</Value>
    </GemOptions>
  </GemOptions>
  <LengthToWidthRatio xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </LengthToWidthRatio>
  <NextPage>sample string 1</NextPage>
  <Page>1</Page>
  <PageSize>1</PageSize>
  <Polish>
    <DiamondPolishLookup>Ideal</DiamondPolishLookup>
    <DiamondPolishLookup>Ideal</DiamondPolishLookup>
  </Polish>
  <PriceRange xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:double>1.1</d2p1:double>
    <d2p1:double>2.1</d2p1:double>
  </PriceRange>
  <SerialNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SerialNumbers>
  <Shape>
    <ShapeFilter>Round</ShapeFilter>
    <ShapeFilter>Round</ShapeFilter>
  </Shape>
  <SizeRange xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </SizeRange>
  <Symmetry>
    <DiamondSymmetryLookup>Ideal</DiamondSymmetryLookup>
    <DiamondSymmetryLookup>Ideal</DiamondSymmetryLookup>
  </Symmetry>
  <TablePercent xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </TablePercent>
</DiamondRequest>

Response Information

Resource Description

DiamondResponse
NameDescriptionTypeAdditional information
Diamonds

The list of serialized stones used to create exports.

Collection of Diamond

None.

NextPage

Used for paging the results. Stores which page the results are currently on.

string

None.

PageSize

The max amount of results to be on each page

integer

None.

TotalNumberOfDiamonds

The total number of products the result is returning.

integer

None.

Response Formats

Sample:

{
  "Diamonds": [
    {
      "CountryOfOrigin": "sample string 1",
      "Length": 2.0,
      "Width": 3.0,
      "Height": 4.0,
      "SerialNumber": 5,
      "Shape": "sample string 6",
      "Clarity": "sample string 7",
      "GemClarity": "sample string 8",
      "CaratWeight": 9.0,
      "NormalizedWeight": "sample string 10",
      "Color": "sample string 11",
      "ColorDescription": "sample string 12",
      "Certification": "sample string 13",
      "CertificationNumber": "sample string 14",
      "Culet": "sample string 15",
      "Depth": 16.0,
      "Table": 17.0,
      "Fluorescence": "sample string 18",
      "Girdle": "sample string 19",
      "Girdle2": "sample string 20",
      "Make": "sample string 21",
      "Polish": "sample string 22",
      "Symmetry": "sample string 23",
      "MMSize": "sample string 24",
      "LastUpdatedDate": "sample string 25",
      "Comments": "sample string 26",
      "MinDiameter": 27.0,
      "MaxDiameter": 28.0,
      "IdealCut": true,
      "RussianCut": true,
      "WebAddress": "sample string 31",
      "CertificatePath": "sample string 32",
      "Cut": "sample string 33",
      "Measurements": "sample string 34",
      "StoneType": "sample string 35",
      "GiaClarity": "sample string 36",
      "Active": true,
      "TotalDepth": "sample string 38",
      "Type": "sample string 39",
      "AGTA": "sample string 40",
      "ColorCode": "sample string 41",
      "Crown": "sample string 42",
      "Pavillion": "sample string 43",
      "Enhancement": "sample string 44",
      "Description": "sample string 45",
      "Images": [
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        },
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        }
      ],
      "Videos": [
        {
          "Url": "sample string 1",
          "DownloadUrl": "sample string 2"
        },
        {
          "Url": "sample string 1",
          "DownloadUrl": "sample string 2"
        }
      ],
      "PercentOffRapnet": 46.0,
      "RapnetPrice": 1.0,
      "IsDiamond": true,
      "IsLabGrownDiamond": true,
      "IsGemstone": true,
      "IsRapnet": true,
      "Size": "sample string 51",
      "Price": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "PricePerCarat": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "ShowcasePrice": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "ShowcasePricePerCarat": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "MatchedSetId": "sample string 52"
    },
    {
      "CountryOfOrigin": "sample string 1",
      "Length": 2.0,
      "Width": 3.0,
      "Height": 4.0,
      "SerialNumber": 5,
      "Shape": "sample string 6",
      "Clarity": "sample string 7",
      "GemClarity": "sample string 8",
      "CaratWeight": 9.0,
      "NormalizedWeight": "sample string 10",
      "Color": "sample string 11",
      "ColorDescription": "sample string 12",
      "Certification": "sample string 13",
      "CertificationNumber": "sample string 14",
      "Culet": "sample string 15",
      "Depth": 16.0,
      "Table": 17.0,
      "Fluorescence": "sample string 18",
      "Girdle": "sample string 19",
      "Girdle2": "sample string 20",
      "Make": "sample string 21",
      "Polish": "sample string 22",
      "Symmetry": "sample string 23",
      "MMSize": "sample string 24",
      "LastUpdatedDate": "sample string 25",
      "Comments": "sample string 26",
      "MinDiameter": 27.0,
      "MaxDiameter": 28.0,
      "IdealCut": true,
      "RussianCut": true,
      "WebAddress": "sample string 31",
      "CertificatePath": "sample string 32",
      "Cut": "sample string 33",
      "Measurements": "sample string 34",
      "StoneType": "sample string 35",
      "GiaClarity": "sample string 36",
      "Active": true,
      "TotalDepth": "sample string 38",
      "Type": "sample string 39",
      "AGTA": "sample string 40",
      "ColorCode": "sample string 41",
      "Crown": "sample string 42",
      "Pavillion": "sample string 43",
      "Enhancement": "sample string 44",
      "Description": "sample string 45",
      "Images": [
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        },
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        }
      ],
      "Videos": [
        {
          "Url": "sample string 1",
          "DownloadUrl": "sample string 2"
        },
        {
          "Url": "sample string 1",
          "DownloadUrl": "sample string 2"
        }
      ],
      "PercentOffRapnet": 46.0,
      "RapnetPrice": 1.0,
      "IsDiamond": true,
      "IsLabGrownDiamond": true,
      "IsGemstone": true,
      "IsRapnet": true,
      "Size": "sample string 51",
      "Price": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "PricePerCarat": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "ShowcasePrice": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "ShowcasePricePerCarat": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "MatchedSetId": "sample string 52"
    }
  ],
  "NextPage": "sample string 1",
  "PageSize": 2,
  "TotalNumberOfDiamonds": 3
}

Sample:

<DiamondResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Diamonds>
    <Diamond>
      <AGTA>sample string 40</AGTA>
      <Active>true</Active>
      <CaratWeight>9</CaratWeight>
      <CertificatePath>sample string 32</CertificatePath>
      <Certification>sample string 13</Certification>
      <CertificationNumber>sample string 14</CertificationNumber>
      <Clarity>sample string 7</Clarity>
      <Color>sample string 11</Color>
      <ColorCode>sample string 41</ColorCode>
      <ColorDescription>sample string 12</ColorDescription>
      <Comments>sample string 26</Comments>
      <CountryOfOrigin>sample string 1</CountryOfOrigin>
      <Crown>sample string 42</Crown>
      <Culet>sample string 15</Culet>
      <Cut>sample string 33</Cut>
      <Depth>16</Depth>
      <Description>sample string 45</Description>
      <Enhancement>sample string 44</Enhancement>
      <Fluorescence>sample string 18</Fluorescence>
      <GemClarity>sample string 8</GemClarity>
      <GiaClarity>sample string 36</GiaClarity>
      <Girdle>sample string 19</Girdle>
      <Girdle2>sample string 20</Girdle2>
      <Height>4</Height>
      <IdealCut>true</IdealCut>
      <Images>
        <Image>
          <FullUrl>sample string 1</FullUrl>
          <ThumbnailUrl>sample string 2</ThumbnailUrl>
          <ZoomUrl>sample string 3</ZoomUrl>
          <MaxHeight>1</MaxHeight>
          <MaxWidth>1</MaxWidth>
          <SortOrder>4</SortOrder>
          <Angle>sample string 5</Angle>
        </Image>
        <Image>
          <FullUrl>sample string 1</FullUrl>
          <ThumbnailUrl>sample string 2</ThumbnailUrl>
          <ZoomUrl>sample string 3</ZoomUrl>
          <MaxHeight>1</MaxHeight>
          <MaxWidth>1</MaxWidth>
          <SortOrder>4</SortOrder>
          <Angle>sample string 5</Angle>
        </Image>
      </Images>
      <IsDiamond>true</IsDiamond>
      <IsGemstone>true</IsGemstone>
      <IsLabGrownDiamond>true</IsLabGrownDiamond>
      <IsRapnet>true</IsRapnet>
      <LastUpdatedDate>sample string 25</LastUpdatedDate>
      <Length>2</Length>
      <MMSize>sample string 24</MMSize>
      <Make>sample string 21</Make>
      <MatchedSetId>sample string 52</MatchedSetId>
      <MaxDiameter>28</MaxDiameter>
      <Measurements>sample string 34</Measurements>
      <MinDiameter>27</MinDiameter>
      <NormalizedWeight>sample string 10</NormalizedWeight>
      <Pavillion>sample string 43</Pavillion>
      <PercentOffRapnet>46</PercentOffRapnet>
      <Polish>sample string 22</Polish>
      <Price>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </Price>
      <PricePerCarat>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </PricePerCarat>
      <RapnetPrice>1</RapnetPrice>
      <RussianCut>true</RussianCut>
      <SerialNumber>5</SerialNumber>
      <Shape>sample string 6</Shape>
      <ShowcasePrice>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </ShowcasePrice>
      <ShowcasePricePerCarat>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </ShowcasePricePerCarat>
      <Size>sample string 51</Size>
      <StoneType>sample string 35</StoneType>
      <Symmetry>sample string 23</Symmetry>
      <Table>17</Table>
      <TotalDepth>sample string 38</TotalDepth>
      <Type>sample string 39</Type>
      <Videos>
        <Video>
          <Url>sample string 1</Url>
          <DownloadUrl>sample string 2</DownloadUrl>
        </Video>
        <Video>
          <Url>sample string 1</Url>
          <DownloadUrl>sample string 2</DownloadUrl>
        </Video>
      </Videos>
      <WebAddress>sample string 31</WebAddress>
      <Width>3</Width>
    </Diamond>
    <Diamond>
      <AGTA>sample string 40</AGTA>
      <Active>true</Active>
      <CaratWeight>9</CaratWeight>
      <CertificatePath>sample string 32</CertificatePath>
      <Certification>sample string 13</Certification>
      <CertificationNumber>sample string 14</CertificationNumber>
      <Clarity>sample string 7</Clarity>
      <Color>sample string 11</Color>
      <ColorCode>sample string 41</ColorCode>
      <ColorDescription>sample string 12</ColorDescription>
      <Comments>sample string 26</Comments>
      <CountryOfOrigin>sample string 1</CountryOfOrigin>
      <Crown>sample string 42</Crown>
      <Culet>sample string 15</Culet>
      <Cut>sample string 33</Cut>
      <Depth>16</Depth>
      <Description>sample string 45</Description>
      <Enhancement>sample string 44</Enhancement>
      <Fluorescence>sample string 18</Fluorescence>
      <GemClarity>sample string 8</GemClarity>
      <GiaClarity>sample string 36</GiaClarity>
      <Girdle>sample string 19</Girdle>
      <Girdle2>sample string 20</Girdle2>
      <Height>4</Height>
      <IdealCut>true</IdealCut>
      <Images>
        <Image>
          <FullUrl>sample string 1</FullUrl>
          <ThumbnailUrl>sample string 2</ThumbnailUrl>
          <ZoomUrl>sample string 3</ZoomUrl>
          <MaxHeight>1</MaxHeight>
          <MaxWidth>1</MaxWidth>
          <SortOrder>4</SortOrder>
          <Angle>sample string 5</Angle>
        </Image>
        <Image>
          <FullUrl>sample string 1</FullUrl>
          <ThumbnailUrl>sample string 2</ThumbnailUrl>
          <ZoomUrl>sample string 3</ZoomUrl>
          <MaxHeight>1</MaxHeight>
          <MaxWidth>1</MaxWidth>
          <SortOrder>4</SortOrder>
          <Angle>sample string 5</Angle>
        </Image>
      </Images>
      <IsDiamond>true</IsDiamond>
      <IsGemstone>true</IsGemstone>
      <IsLabGrownDiamond>true</IsLabGrownDiamond>
      <IsRapnet>true</IsRapnet>
      <LastUpdatedDate>sample string 25</LastUpdatedDate>
      <Length>2</Length>
      <MMSize>sample string 24</MMSize>
      <Make>sample string 21</Make>
      <MatchedSetId>sample string 52</MatchedSetId>
      <MaxDiameter>28</MaxDiameter>
      <Measurements>sample string 34</Measurements>
      <MinDiameter>27</MinDiameter>
      <NormalizedWeight>sample string 10</NormalizedWeight>
      <Pavillion>sample string 43</Pavillion>
      <PercentOffRapnet>46</PercentOffRapnet>
      <Polish>sample string 22</Polish>
      <Price>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </Price>
      <PricePerCarat>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </PricePerCarat>
      <RapnetPrice>1</RapnetPrice>
      <RussianCut>true</RussianCut>
      <SerialNumber>5</SerialNumber>
      <Shape>sample string 6</Shape>
      <ShowcasePrice>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </ShowcasePrice>
      <ShowcasePricePerCarat>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </ShowcasePricePerCarat>
      <Size>sample string 51</Size>
      <StoneType>sample string 35</StoneType>
      <Symmetry>sample string 23</Symmetry>
      <Table>17</Table>
      <TotalDepth>sample string 38</TotalDepth>
      <Type>sample string 39</Type>
      <Videos>
        <Video>
          <Url>sample string 1</Url>
          <DownloadUrl>sample string 2</DownloadUrl>
        </Video>
        <Video>
          <Url>sample string 1</Url>
          <DownloadUrl>sample string 2</DownloadUrl>
        </Video>
      </Videos>
      <WebAddress>sample string 31</WebAddress>
      <Width>3</Width>
    </Diamond>
  </Diamonds>
  <NextPage>sample string 1</NextPage>
  <PageSize>2</PageSize>
  <TotalNumberOfDiamonds>3</TotalNumberOfDiamonds>
</DiamondResponse>