POST request/supplier/productconfig

Creates the Product configuration for Logged in Supplier

Request Information

URI Parameters

None.

Body Parameters

ProductconfigPost
NameDescriptionTypeAdditional information
AcceptableBuyerCreditRanking

integer

None.

AgreedPrivacyPolicy

boolean

None.

AgreedTermsAndConditions

boolean

None.

AllowPartnership

boolean

None.

AllowSoleTraders

boolean

None.

BespokeMaxSites

integer

None.

BespokeMinAQ

integer

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.

Request Formats

application/json, text/json

Sample:
{
  "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:
{"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:
<ProductconfigPost 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>
</ProductconfigPost>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json, text/html

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>