GET v3/website/widgets/featuredProducts

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

StoreFeaturedProductListResponse
NameDescriptionTypeAdditional information
apiStatus

string

None.

isApproved

boolean

None.

data

Collection of StoreFeaturedProductList

None.

Response Formats

application/json, text/json

Sample:
{
  "apiStatus": "sample string 1",
  "isApproved": true,
  "data": [
    {
      "title": "sample string 1",
      "type": "sample string 2",
      "imageUrl": "sample string 3",
      "imagePosition": "sample string 4",
      "href": "sample string 5",
      "backgroundColor": "sample string 6",
      "parameters": "sample string 7",
      "products": [
        {
          "images": [
            "sample string 1",
            "sample string 2"
          ],
          "referenceCode": "sample string 1",
          "colorCode": "sample string 2",
          "color": "sample string 3",
          "title": "sample string 4",
          "productType": "sample string 5",
          "brand": "sample string 6",
          "family": "sample string 7",
          "gender": "sample string 8",
          "price": 9.0,
          "discountPrice": 10.0,
          "discountTimerShow": true,
          "discountTimerEnd": "2022-10-07T14:01:43.150497-06:00",
          "discountTimerPrice": 12.0,
          "position": 13,
          "customValueD": "sample string 14",
          "size": "sample string 15",
          "stock": 16,
          "externalId": 17
        },
        {
          "images": [
            "sample string 1",
            "sample string 2"
          ],
          "referenceCode": "sample string 1",
          "colorCode": "sample string 2",
          "color": "sample string 3",
          "title": "sample string 4",
          "productType": "sample string 5",
          "brand": "sample string 6",
          "family": "sample string 7",
          "gender": "sample string 8",
          "price": 9.0,
          "discountPrice": 10.0,
          "discountTimerShow": true,
          "discountTimerEnd": "2022-10-07T14:01:43.150497-06:00",
          "discountTimerPrice": 12.0,
          "position": 13,
          "customValueD": "sample string 14",
          "size": "sample string 15",
          "stock": 16,
          "externalId": 17
        }
      ]
    },
    {
      "title": "sample string 1",
      "type": "sample string 2",
      "imageUrl": "sample string 3",
      "imagePosition": "sample string 4",
      "href": "sample string 5",
      "backgroundColor": "sample string 6",
      "parameters": "sample string 7",
      "products": [
        {
          "images": [
            "sample string 1",
            "sample string 2"
          ],
          "referenceCode": "sample string 1",
          "colorCode": "sample string 2",
          "color": "sample string 3",
          "title": "sample string 4",
          "productType": "sample string 5",
          "brand": "sample string 6",
          "family": "sample string 7",
          "gender": "sample string 8",
          "price": 9.0,
          "discountPrice": 10.0,
          "discountTimerShow": true,
          "discountTimerEnd": "2022-10-07T14:01:43.150497-06:00",
          "discountTimerPrice": 12.0,
          "position": 13,
          "customValueD": "sample string 14",
          "size": "sample string 15",
          "stock": 16,
          "externalId": 17
        },
        {
          "images": [
            "sample string 1",
            "sample string 2"
          ],
          "referenceCode": "sample string 1",
          "colorCode": "sample string 2",
          "color": "sample string 3",
          "title": "sample string 4",
          "productType": "sample string 5",
          "brand": "sample string 6",
          "family": "sample string 7",
          "gender": "sample string 8",
          "price": 9.0,
          "discountPrice": 10.0,
          "discountTimerShow": true,
          "discountTimerEnd": "2022-10-07T14:01:43.150497-06:00",
          "discountTimerPrice": 12.0,
          "position": 13,
          "customValueD": "sample string 14",
          "size": "sample string 15",
          "stock": 16,
          "externalId": 17
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<StoreFeaturedProductListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <apiStatus>sample string 1</apiStatus>
  <data>
    <StoreFeaturedProductList>
      <backgroundColor>sample string 6</backgroundColor>
      <href>sample string 5</href>
      <imagePosition>sample string 4</imagePosition>
      <imageUrl>sample string 3</imageUrl>
      <parameters>sample string 7</parameters>
      <products>
        <StoreFeaturedProduct>
          <brand>sample string 6</brand>
          <color>sample string 3</color>
          <colorCode>sample string 2</colorCode>
          <customValueD>sample string 14</customValueD>
          <discountPrice>10</discountPrice>
          <discountTimerEnd>2022-10-07T14:01:43.150497-06:00</discountTimerEnd>
          <discountTimerPrice>12</discountTimerPrice>
          <discountTimerShow>true</discountTimerShow>
          <externalId>17</externalId>
          <family>sample string 7</family>
          <gender>sample string 8</gender>
          <images xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </images>
          <position>13</position>
          <price>9</price>
          <productType>sample string 5</productType>
          <referenceCode>sample string 1</referenceCode>
          <size>sample string 15</size>
          <stock>16</stock>
          <title>sample string 4</title>
        </StoreFeaturedProduct>
        <StoreFeaturedProduct>
          <brand>sample string 6</brand>
          <color>sample string 3</color>
          <colorCode>sample string 2</colorCode>
          <customValueD>sample string 14</customValueD>
          <discountPrice>10</discountPrice>
          <discountTimerEnd>2022-10-07T14:01:43.150497-06:00</discountTimerEnd>
          <discountTimerPrice>12</discountTimerPrice>
          <discountTimerShow>true</discountTimerShow>
          <externalId>17</externalId>
          <family>sample string 7</family>
          <gender>sample string 8</gender>
          <images xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </images>
          <position>13</position>
          <price>9</price>
          <productType>sample string 5</productType>
          <referenceCode>sample string 1</referenceCode>
          <size>sample string 15</size>
          <stock>16</stock>
          <title>sample string 4</title>
        </StoreFeaturedProduct>
      </products>
      <title>sample string 1</title>
      <type>sample string 2</type>
    </StoreFeaturedProductList>
    <StoreFeaturedProductList>
      <backgroundColor>sample string 6</backgroundColor>
      <href>sample string 5</href>
      <imagePosition>sample string 4</imagePosition>
      <imageUrl>sample string 3</imageUrl>
      <parameters>sample string 7</parameters>
      <products>
        <StoreFeaturedProduct>
          <brand>sample string 6</brand>
          <color>sample string 3</color>
          <colorCode>sample string 2</colorCode>
          <customValueD>sample string 14</customValueD>
          <discountPrice>10</discountPrice>
          <discountTimerEnd>2022-10-07T14:01:43.150497-06:00</discountTimerEnd>
          <discountTimerPrice>12</discountTimerPrice>
          <discountTimerShow>true</discountTimerShow>
          <externalId>17</externalId>
          <family>sample string 7</family>
          <gender>sample string 8</gender>
          <images xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </images>
          <position>13</position>
          <price>9</price>
          <productType>sample string 5</productType>
          <referenceCode>sample string 1</referenceCode>
          <size>sample string 15</size>
          <stock>16</stock>
          <title>sample string 4</title>
        </StoreFeaturedProduct>
        <StoreFeaturedProduct>
          <brand>sample string 6</brand>
          <color>sample string 3</color>
          <colorCode>sample string 2</colorCode>
          <customValueD>sample string 14</customValueD>
          <discountPrice>10</discountPrice>
          <discountTimerEnd>2022-10-07T14:01:43.150497-06:00</discountTimerEnd>
          <discountTimerPrice>12</discountTimerPrice>
          <discountTimerShow>true</discountTimerShow>
          <externalId>17</externalId>
          <family>sample string 7</family>
          <gender>sample string 8</gender>
          <images xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </images>
          <position>13</position>
          <price>9</price>
          <productType>sample string 5</productType>
          <referenceCode>sample string 1</referenceCode>
          <size>sample string 15</size>
          <stock>16</stock>
          <title>sample string 4</title>
        </StoreFeaturedProduct>
      </products>
      <title>sample string 1</title>
      <type>sample string 2</type>
    </StoreFeaturedProductList>
  </data>
  <isApproved>true</isApproved>
</StoreFeaturedProductListResponse>