PUT request/supplier/{SupplierId}/productconfig
Updates the Product configuration details for the Logged in Supplier
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SupplierId | integer |
Required |
Body Parameters
ProductconfigPut| Name | Description | Type | Additional information |
|---|---|---|---|
| AcceptableBuyerCreditRanking | integer |
None. |
|
| AgreedPrivacyPolicy | boolean |
None. |
|
| AgreedTermsAndConditions | boolean |
None. |
|
| AllowPartnership | boolean |
None. |
|
| AllowSoleTraders | boolean |
None. |
|
| BespokeMaxSites | integer |
None. |
|
| BespokeMinAQ | integer |
None. |
|
| CommissionPaymentTypeId | byte |
None. |
|
| CommissionPaymentTypeName | string |
None. |
|
| ContractDaysElec | integer |
None. |
|
| ContractDaysGas | integer |
None. |
|
| ContractPreferenceID | integer |
None. |
|
| DnBFinancialStrength | string |
None. |
|
| DnBRiskIndicator | byte |
None. |
|
| HasStandingChargeCommission | boolean |
None. |
|
| MaxElecConsumption | integer |
None. |
|
| MaxElecSupplierCommission | decimal number |
None. |
|
| MaxGasConsumption | integer |
None. |
|
| MaxGasSupplierCommission | decimal number |
None. |
|
| MAXSITES | integer |
None. |
|
| ProductId | byte |
None. |
|
| SupplierId | byte |
None. |
|
| SupplierName | string |
None. |
|
| SupplierProductConfigurationId | integer |
None. |
|
| SupplierProductStatusId | byte |
None. |
|
| UpfrontCommissionPercent | decimal number |
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,
"allowSoleTraders": true,
"allowPartnership": true,
"maxsites": 1,
"maxElecSupplierCommission": 1.0,
"maxGasSupplierCommission": 1.0,
"maxElecConsumption": 1,
"maxGasConsumption": 1,
"contractPreferenceID": 1,
"contractDaysElec": 1,
"contractDaysGas": 1,
"hasStandingChargeCommission": true,
"commissionPaymentTypeId": 64,
"upfrontCommissionPercent": 1.0,
"commissionPaymentTypeName": "sample string 5"
}
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,"allowSoleTraders":true,"allowPartnership":true,"maxsites":1,"maxElecSupplierCommission":1.0,"maxGasSupplierCommission":1.0,"maxElecConsumption":1,"maxGasConsumption":1,"contractPreferenceID":1,"contractDaysElec":1,"contractDaysGas":1,"hasStandingChargeCommission":true,"commissionPaymentTypeId":64,"upfrontCommissionPercent":1.0,"commissionPaymentTypeName":"sample string 5"}
application/xml, text/xml
Sample:
<ProductconfigPut 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> <CommissionPaymentTypeId>64</CommissionPaymentTypeId> <CommissionPaymentTypeName>sample string 5</CommissionPaymentTypeName> <ContractDaysElec>1</ContractDaysElec> <ContractDaysGas>1</ContractDaysGas> <ContractPreferenceID>1</ContractPreferenceID> <DnBFinancialStrength>sample string 3</DnBFinancialStrength> <DnBRiskIndicator>64</DnBRiskIndicator> <HasStandingChargeCommission>true</HasStandingChargeCommission> <MAXSITES>1</MAXSITES> <MaxElecConsumption>1</MaxElecConsumption> <MaxElecSupplierCommission>1</MaxElecSupplierCommission> <MaxGasConsumption>1</MaxGasConsumption> <MaxGasSupplierCommission>1</MaxGasSupplierCommission> <ProductId>64</ProductId> <SupplierId>64</SupplierId> <SupplierName>sample string 2</SupplierName> <SupplierProductConfigurationId>1</SupplierProductConfigurationId> <SupplierProductStatusId>64</SupplierProductStatusId> <UpfrontCommissionPercent>1</UpfrontCommissionPercent> </ProductconfigPut>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
booleanResponse Formats
application/json, text/json, text/html
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>