POST v3/website/widgets/productLists?groupId={groupId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupId

integer

Required

Body Parameters

Collection of AppFeaturedProductList
NameDescriptionTypeAdditional information
title

string

None.

type

string

None.

imageUrl

string

None.

imagePosition

string

None.

href

string

None.

backgroundColor

string

None.

parameters

string

None.

position

integer

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "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",
    "position": 8
  },
  {
    "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",
    "position": 8
  }
]

application/xml, text/xml

Sample:
<ArrayOfAppFeaturedProductList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <AppFeaturedProductList>
    <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>
    <position>8</position>
    <title>sample string 1</title>
    <type>sample string 2</type>
  </AppFeaturedProductList>
  <AppFeaturedProductList>
    <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>
    <position>8</position>
    <title>sample string 1</title>
    <type>sample string 2</type>
  </AppFeaturedProductList>
</ArrayOfAppFeaturedProductList>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AppFeaturedProductListResponse
NameDescriptionTypeAdditional information
apiStatus

string

None.

isApproved

boolean

None.

data

Collection of AppFeaturedProductList

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",
      "position": 8
    },
    {
      "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",
      "position": 8
    }
  ]
}

application/xml, text/xml

Sample:
<AppFeaturedProductListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <apiStatus>sample string 1</apiStatus>
  <data>
    <AppFeaturedProductList>
      <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>
      <position>8</position>
      <title>sample string 1</title>
      <type>sample string 2</type>
    </AppFeaturedProductList>
    <AppFeaturedProductList>
      <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>
      <position>8</position>
      <title>sample string 1</title>
      <type>sample string 2</type>
    </AppFeaturedProductList>
  </data>
  <isApproved>true</isApproved>
</AppFeaturedProductListResponse>