FindPriceRuleWithValidity


 

Overview

Quick Links

This method retrieves Price Rules according to a specified set of criteria.

Resource Information



Request FormatXML
Response FormatXML

Request Header

NameTypeDescription
StringStringAuthentication Token

Request Body

NameTypeDescription
customerCodeStringThe unique customer code of a Customer the Price Rule should apply to
productClusterTagNameStringThe name of the Product Cluster the Price Rule should apply to
fromDateStringThe start date of the validity range
toDateStringThe end date of the validity range. The range defined by this start and end date filter the price rules by only retrieving those price rules whose own validity range overlaps with this range.

Response

NameTypeDescription
ResultList of Price RulesReturns the details of the Price Rule in the system you requested.
ResultCodeStringString indicating the result. Either "Success" or "Error".
ResultMessageStringEmpty when call successful, error message otherwise.

In the case of an internal unhandled fault, a Fault object is returned instead. Providing information on what occurred exactly.

Examples

Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Header xmlns:s="System"><s:String>601010c5-0d96-4c69-86e4-29e9b3645d45</s:String></Header>
 <Body>
 <FindPriceRuleWithValidity xmlns="http://tempuri.org/">
 <customerCode>C080</customerCode>
 <productClusterTagName>Product 001</productClusterTagName>
 <fromDate>2014-12-01T00:00:00</fromDate>
 <toDate>2014-12-31T00:00:00</toDate>
 </FindPriceRuleWithValidity>
 </Body>
</Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
 <s:Body>
 <FindPriceRuleWithValidityResponse xmlns="http://tempuri.org/">
 <FindPriceRuleWithValidityResult xmlns:a="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_0" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
 <a:Result>
 <a:PricingRule>
 <a:BillingOutputTags xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
 <a:ChargePerUOM>None</a:ChargePerUOM>
 <a:CostOperatorValue>0</a:CostOperatorValue>
 <a:CostOperatorValueExpression i:nil="true"/>
 <a:CustomerClusterId>5491c6f6ae8b10e33a13a5da</a:CustomerClusterId>
 <a:CustomerClusterRelativeLevel>0</a:CustomerClusterRelativeLevel>
 <a:CustomerClusterTagName>Customer 080</a:CustomerClusterTagName>
 <a:Id>549979076fdaed05a8ce154a</a:Id>
 <a:InvoiceLabelKey i:nil="true"/>
 <a:InvoiceLabelOverrides xmlns:b="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="true"/>
 <a:InvoiceOrderIndex>0</a:InvoiceOrderIndex>
 <a:IsFinalResult>false</a:IsFinalResult>
 <a:IsInvoiceRule>false</a:IsInvoiceRule>
 <a:ItemCondition i:nil="true"/>
 <a:Ladder i:nil="true"/>
 <a:Operator>PRICE</a:Operator>
 <a:OperatorValue>1</a:OperatorValue>
 <a:OperatorValueExpression i:nil="true"/>
 <a:OverridenRuleName i:nil="true"/>
 <a:ProRataPriceUOM>None</a:ProRataPriceUOM>
 <a:ProRataRoundingTypeFrom>None</a:ProRataRoundingTypeFrom>
 <a:ProRataRoundingTypeTo>None</a:ProRataRoundingTypeTo>
 <a:ProductClusterId>5491c6feae8b10e33a13a654</a:ProductClusterId>
 <a:ProductClusterRelativeLevel>0</a:ProductClusterRelativeLevel>
 <a:ProductClusterTagName>Product 001</a:ProductClusterTagName>
 <a:RuleCondition i:nil="true"/>
 <a:RuleCreated>2014-12-23T15:15:35.553+01:00</a:RuleCreated>
 <a:RuleName>Validity regel</a:RuleName>
 <a:RuleOrder>0</a:RuleOrder>
 <a:SeparateDiscountValue>false</a:SeparateDiscountValue>
 <a:SeparateLineItemBillingOutputTags xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
 <a:UpdatedDate>2014-12-23T15:15:52.178+01:00</a:UpdatedDate>
 <a:ValidFrom>2014-12-01T00:00:00.000+01:00</a:ValidFrom>
 <a:ValidTo>2014-12-31T00:00:59.999+01:00</a:ValidTo>
 </a:PricingRule>
 <a:PricingRule>
 <a:BillingOutputTags xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
 <a:ChargePerUOM>None</a:ChargePerUOM>
 <a:CostOperatorValue>1</a:CostOperatorValue>
 <a:CostOperatorValueExpression i:nil="true"/>
 <a:CustomerClusterId>5491c6f6ae8b10e33a13a5da</a:CustomerClusterId>
 <a:CustomerClusterRelativeLevel>0</a:CustomerClusterRelativeLevel>
 <a:CustomerClusterTagName>Customer 080</a:CustomerClusterTagName>
 <a:Id>5491c705ae8b10e33a13a6f1</a:Id>
 <a:InvoiceLabelKey>UnitPrice</a:InvoiceLabelKey>
 <a:InvoiceLabelOverrides xmlns:b="http://schemas.datacontract.org/2004/07/System.Collections.Generic"/>
 <a:InvoiceOrderIndex>1</a:InvoiceOrderIndex>
 <a:IsFinalResult>false</a:IsFinalResult>
 <a:IsInvoiceRule>true</a:IsInvoiceRule>
 <a:ItemCondition i:nil="true"/>
 <a:Ladder i:nil="true"/>
 <a:Operator>PRICE</a:Operator>
 <a:OperatorValue>1</a:OperatorValue>
 <a:OperatorValueExpression i:nil="true"/>
 <a:OverridenRuleName i:nil="true"/>
 <a:ProRataPriceUOM>None</a:ProRataPriceUOM>
 <a:ProRataRoundingTypeFrom>None</a:ProRataRoundingTypeFrom>
 <a:ProRataRoundingTypeTo>None</a:ProRataRoundingTypeTo>
 <a:ProductClusterId>5491c6feae8b10e33a13a654</a:ProductClusterId>
 <a:ProductClusterRelativeLevel>0</a:ProductClusterRelativeLevel>
 <a:ProductClusterTagName>Product 001</a:ProductClusterTagName>
 <a:RuleCondition i:nil="true"/>
 <a:RuleCreated>2014-01-01T12:34:56.789+01:00</a:RuleCreated>
 <a:RuleName>Product 001 PRICE</a:RuleName>
 <a:RuleOrder>1</a:RuleOrder>
 <a:SeparateDiscountValue>false</a:SeparateDiscountValue>
 <a:SeparateLineItemBillingOutputTags xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
 <a:UpdatedDate>2014-12-23T14:52:05.631+01:00</a:UpdatedDate>
 <a:ValidFrom>2014-12-01T00:00:00.000+01:00</a:ValidFrom>
 <a:ValidTo>2014-12-31T00:00:59.999+01:00</a:ValidTo>
 </a:PricingRule>
 </a:Result>
 <a:ResultCode>Success</a:ResultCode>
 <a:ResultMessage/>
 </FindPriceRuleWithValidityResult>
 </FindPriceRuleWithValidityResponse>
 </s:Body>
</s:Envelope>