GET request/supplier/productconfig

Displays the Product configuration for Logged in Supplier

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ProductConfigView

Name	Type	Additional information
AcceptableBuyerCreditRanking	integer	None.
AgreedPrivacyPolicy	boolean	None.
AgreedTermsAndConditions	boolean	None.
AllowPartnership	boolean	None.
AllowSoleTraders	boolean	None.
BespokeMaxSites	integer	None.
BespokeMinAQ	integer	None.
brandsuppconfigs	Collection of BrandSupplierConfig	None.
ContractDaysElec	integer	None.
ContractDaysGas	integer	None.
ContractPreferenceID	integer	None.
DnBFinancialStrength	string	None.
DnBRiskIndicator	byte	None.
MaxElecConsumption	integer	None.
MaxGasConsumption	integer	None.
MAXSITES	integer	None.
MaxSupplierCommission	decimal number	None.
ProductId	byte	None.
SupplierId	byte	None.
SupplierName	string	None.
SupplierProductConfigurationId	integer	None.
SupplierProductStatusId	byte	None.

Response Formats

application/json, text/json

Sample:

{
  "brandsuppconfigs": [
    {
      "brandid": 1,
      "brandname": "sample string 1",
      "supplierID": 64,
      "supplierName": "sample string 3",
      "supplierFilter": true,
      "inclusion": true,
      "exclusion": true,
      "parentCompany": "sample string 6",
      "parentCompanyID": 7,
      "companyTypeId": 1,
      "companyType": "sample string 8",
      "vatNumber": "sample string 9",
      "website": "sample string 10",
      "landline": "sample string 11",
      "mobileNumber": "sample string 12",
      "postAddressLine1": "sample string 13",
      "postAddressLine2": "sample string 14",
      "postAddressCity": "sample string 15",
      "postAddressCounty": "sample string 16",
      "postAddressPostcode": "sample string 17",
      "regAddressLine1": "sample string 18",
      "regAddressLine2": "sample string 19",
      "regaddressCity": "sample string 20",
      "regAddressCounty": "sample string 21",
      "regAddressPostcode": "sample string 22",
      "billAddressLine1": "sample string 23",
      "billAddressLine2": "sample string 24",
      "billAddressCity": "sample string 25",
      "billAddressCounty": "sample string 26",
      "billAddressPostcode": "sample string 27",
      "companyLogo": "sample string 28",
      "primarycolour": "sample string 29",
      "secondaryColour": "sample string 30",
      "fontType": "sample string 31",
      "headerStyle": "sample string 32",
      "sidebarStyle": "sample string 33"
    },
    {
      "brandid": 1,
      "brandname": "sample string 1",
      "supplierID": 64,
      "supplierName": "sample string 3",
      "supplierFilter": true,
      "inclusion": true,
      "exclusion": true,
      "parentCompany": "sample string 6",
      "parentCompanyID": 7,
      "companyTypeId": 1,
      "companyType": "sample string 8",
      "vatNumber": "sample string 9",
      "website": "sample string 10",
      "landline": "sample string 11",
      "mobileNumber": "sample string 12",
      "postAddressLine1": "sample string 13",
      "postAddressLine2": "sample string 14",
      "postAddressCity": "sample string 15",
      "postAddressCounty": "sample string 16",
      "postAddressPostcode": "sample string 17",
      "regAddressLine1": "sample string 18",
      "regAddressLine2": "sample string 19",
      "regaddressCity": "sample string 20",
      "regAddressCounty": "sample string 21",
      "regAddressPostcode": "sample string 22",
      "billAddressLine1": "sample string 23",
      "billAddressLine2": "sample string 24",
      "billAddressCity": "sample string 25",
      "billAddressCounty": "sample string 26",
      "billAddressPostcode": "sample string 27",
      "companyLogo": "sample string 28",
      "primarycolour": "sample string 29",
      "secondaryColour": "sample string 30",
      "fontType": "sample string 31",
      "headerStyle": "sample string 32",
      "sidebarStyle": "sample string 33"
    }
  ],
  "supplierProductConfigurationId": 1,
  "supplierId": 64,
  "supplierName": "sample string 2",
  "productId": 64,
  "supplierProductStatusId": 64,
  "agreedPrivacyPolicy": true,
  "agreedTermsAndConditions": true,
  "acceptableBuyerCreditRanking": 1,
  "dnBFinancialStrength": "sample string 3",
  "dnBRiskIndicator": 64,
  "bespokeMinAQ": 1,
  "bespokeMaxSites": 1,
  "maxSupplierCommission": 1.0,
  "allowSoleTraders": true,
  "allowPartnership": true,
  "maxsites": 1,
  "maxElecConsumption": 1,
  "maxGasConsumption": 1,
  "contractPreferenceID": 1,
  "contractDaysElec": 1,
  "contractDaysGas": 1
}

text/html

Sample:

{"brandsuppconfigs":[{"brandid":1,"brandname":"sample string 1","supplierID":64,"supplierName":"sample string 3","supplierFilter":true,"inclusion":true,"exclusion":true,"parentCompany":"sample string 6","parentCompanyID":7,"companyTypeId":1,"companyType":"sample string 8","vatNumber":"sample string 9","website":"sample string 10","landline":"sample string 11","mobileNumber":"sample string 12","postAddressLine1":"sample string 13","postAddressLine2":"sample string 14","postAddressCity":"sample string 15","postAddressCounty":"sample string 16","postAddressPostcode":"sample string 17","regAddressLine1":"sample string 18","regAddressLine2":"sample string 19","regaddressCity":"sample string 20","regAddressCounty":"sample string 21","regAddressPostcode":"sample string 22","billAddressLine1":"sample string 23","billAddressLine2":"sample string 24","billAddressCity":"sample string 25","billAddressCounty":"sample string 26","billAddressPostcode":"sample string 27","companyLogo":"sample string 28","primarycolour":"sample string 29","secondaryColour":"sample string 30","fontType":"sample string 31","headerStyle":"sample string 32","sidebarStyle":"sample string 33"},{"brandid":1,"brandname":"sample string 1","supplierID":64,"supplierName":"sample string 3","supplierFilter":true,"inclusion":true,"exclusion":true,"parentCompany":"sample string 6","parentCompanyID":7,"companyTypeId":1,"companyType":"sample string 8","vatNumber":"sample string 9","website":"sample string 10","landline":"sample string 11","mobileNumber":"sample string 12","postAddressLine1":"sample string 13","postAddressLine2":"sample string 14","postAddressCity":"sample string 15","postAddressCounty":"sample string 16","postAddressPostcode":"sample string 17","regAddressLine1":"sample string 18","regAddressLine2":"sample string 19","regaddressCity":"sample string 20","regAddressCounty":"sample string 21","regAddressPostcode":"sample string 22","billAddressLine1":"sample string 23","billAddressLine2":"sample string 24","billAddressCity":"sample string 25","billAddressCounty":"sample string 26","billAddressPostcode":"sample string 27","companyLogo":"sample string 28","primarycolour":"sample string 29","secondaryColour":"sample string 30","fontType":"sample string 31","headerStyle":"sample string 32","sidebarStyle":"sample string 33"}],"supplierProductConfigurationId":1,"supplierId":64,"supplierName":"sample string 2","productId":64,"supplierProductStatusId":64,"agreedPrivacyPolicy":true,"agreedTermsAndConditions":true,"acceptableBuyerCreditRanking":1,"dnBFinancialStrength":"sample string 3","dnBRiskIndicator":64,"bespokeMinAQ":1,"bespokeMaxSites":1,"maxSupplierCommission":1.0,"allowSoleTraders":true,"allowPartnership":true,"maxsites":1,"maxElecConsumption":1,"maxGasConsumption":1,"contractPreferenceID":1,"contractDaysElec":1,"contractDaysGas":1}

application/xml, text/xml

Sample:

<ProductConfigView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.SupplierDetails.ProductConfig">
  <AcceptableBuyerCreditRanking>1</AcceptableBuyerCreditRanking>
  <AgreedPrivacyPolicy>true</AgreedPrivacyPolicy>
  <AgreedTermsAndConditions>true</AgreedTermsAndConditions>
  <AllowPartnership>true</AllowPartnership>
  <AllowSoleTraders>true</AllowSoleTraders>
  <BespokeMaxSites>1</BespokeMaxSites>
  <BespokeMinAQ>1</BespokeMinAQ>
  <ContractDaysElec>1</ContractDaysElec>
  <ContractDaysGas>1</ContractDaysGas>
  <ContractPreferenceID>1</ContractPreferenceID>
  <DnBFinancialStrength>sample string 3</DnBFinancialStrength>
  <DnBRiskIndicator>64</DnBRiskIndicator>
  <MAXSITES>1</MAXSITES>
  <MaxElecConsumption>1</MaxElecConsumption>
  <MaxGasConsumption>1</MaxGasConsumption>
  <MaxSupplierCommission>1</MaxSupplierCommission>
  <ProductId>64</ProductId>
  <SupplierId>64</SupplierId>
  <SupplierName>sample string 2</SupplierName>
  <SupplierProductConfigurationId>1</SupplierProductConfigurationId>
  <SupplierProductStatusId>64</SupplierProductStatusId>
  <brandsuppconfigs>
    <BrandSupplierConfig>
      <BRANDID>1</BRANDID>
      <BRANDNAME>sample string 1</BRANDNAME>
      <BillAddressCity>sample string 25</BillAddressCity>
      <BillAddressCounty>sample string 26</BillAddressCounty>
      <BillAddressLine1>sample string 23</BillAddressLine1>
      <BillAddressLine2>sample string 24</BillAddressLine2>
      <BillAddressPostcode>sample string 27</BillAddressPostcode>
      <CompanyLogo>sample string 28</CompanyLogo>
      <CompanyTypeId>1</CompanyTypeId>
      <Exclusion>true</Exclusion>
      <FontType>sample string 31</FontType>
      <HeaderStyle>sample string 32</HeaderStyle>
      <Inclusion>true</Inclusion>
      <Landline>sample string 11</Landline>
      <MobileNumber>sample string 12</MobileNumber>
      <ParentCompany>sample string 6</ParentCompany>
      <ParentCompanyID>7</ParentCompanyID>
      <PostAddressCity>sample string 15</PostAddressCity>
      <PostAddressCounty>sample string 16</PostAddressCounty>
      <PostAddressLine1>sample string 13</PostAddressLine1>
      <PostAddressLine2>sample string 14</PostAddressLine2>
      <PostAddressPostcode>sample string 17</PostAddressPostcode>
      <Primarycolour>sample string 29</Primarycolour>
      <RegAddressCounty>sample string 21</RegAddressCounty>
      <RegAddressLine1>sample string 18</RegAddressLine1>
      <RegAddressLine2>sample string 19</RegAddressLine2>
      <RegAddressPostcode>sample string 22</RegAddressPostcode>
      <RegaddressCity>sample string 20</RegaddressCity>
      <SecondaryColour>sample string 30</SecondaryColour>
      <SidebarStyle>sample string 33</SidebarStyle>
      <SupplierFilter>true</SupplierFilter>
      <SupplierID>64</SupplierID>
      <SupplierName>sample string 3</SupplierName>
      <VATNumber>sample string 9</VATNumber>
      <Website>sample string 10</Website>
      <companyType>sample string 8</companyType>
    </BrandSupplierConfig>
    <BrandSupplierConfig>
      <BRANDID>1</BRANDID>
      <BRANDNAME>sample string 1</BRANDNAME>
      <BillAddressCity>sample string 25</BillAddressCity>
      <BillAddressCounty>sample string 26</BillAddressCounty>
      <BillAddressLine1>sample string 23</BillAddressLine1>
      <BillAddressLine2>sample string 24</BillAddressLine2>
      <BillAddressPostcode>sample string 27</BillAddressPostcode>
      <CompanyLogo>sample string 28</CompanyLogo>
      <CompanyTypeId>1</CompanyTypeId>
      <Exclusion>true</Exclusion>
      <FontType>sample string 31</FontType>
      <HeaderStyle>sample string 32</HeaderStyle>
      <Inclusion>true</Inclusion>
      <Landline>sample string 11</Landline>
      <MobileNumber>sample string 12</MobileNumber>
      <ParentCompany>sample string 6</ParentCompany>
      <ParentCompanyID>7</ParentCompanyID>
      <PostAddressCity>sample string 15</PostAddressCity>
      <PostAddressCounty>sample string 16</PostAddressCounty>
      <PostAddressLine1>sample string 13</PostAddressLine1>
      <PostAddressLine2>sample string 14</PostAddressLine2>
      <PostAddressPostcode>sample string 17</PostAddressPostcode>
      <Primarycolour>sample string 29</Primarycolour>
      <RegAddressCounty>sample string 21</RegAddressCounty>
      <RegAddressLine1>sample string 18</RegAddressLine1>
      <RegAddressLine2>sample string 19</RegAddressLine2>
      <RegAddressPostcode>sample string 22</RegAddressPostcode>
      <RegaddressCity>sample string 20</RegaddressCity>
      <SecondaryColour>sample string 30</SecondaryColour>
      <SidebarStyle>sample string 33</SidebarStyle>
      <SupplierFilter>true</SupplierFilter>
      <SupplierID>64</SupplierID>
      <SupplierName>sample string 3</SupplierName>
      <VATNumber>sample string 9</VATNumber>
      <Website>sample string 10</Website>
      <companyType>sample string 8</companyType>
    </BrandSupplierConfig>
  </brandsuppconfigs>
</ProductConfigView>