- - - - - - - - - The Canadian Postal Code FSA Part (Forward Sortation Area) - - - The Canadian Postal Code LDU part (Local Delivery Unit) - - - Code indicating the business channel One of (COMMERCIAL, CONSUMER) - - - The Canada Post Customer number - - - Customer Contract Number - - - Contract price discount level to be used in rating. - - - Fully qualified Product and Service Identifier. - - Country Code used to identify the destination scope of the mailing. This field is mandatory - - Province or Sate code. This is a 2 character code for domestic and US mailings. - - Destination Zip Code. Used for US mailings only. - - - 3 Digit International City Code - - - - - - - - - - - - - - - Indicates the price level used in rating. - - Indicates the rate code that applied to the mailing scenario. Applies to Distribution Rating Only. - - Indicates if Air Stage Freight Rates came into effect. Applies to Distribution Rating only. - - Indicates the rate tax code used. - - Price per individual mail piece. May not be applicable for all products. - - Price per KG. Applies only to Communications Products. - - When pricing is based on both price per piece and price per unit of weight this value is a blended price per piece. - - Calculated cubed weight. When this value is greater than the value entered, cubed weighting applies. - - The amount of weight that could be added to the shipment without incurring additional cost. This value is returned if the INCLUDEFREEWEIGHT handling flag is included in the request. - - Province or State code used in Rating. In the case where State Code was implied from ZIP or partial ZIP the state code will be returned - - CountryCode Used for Rating. In cases where States are submitted in the request but rating is performed as a country the country code is returned - - - - Indicates the step size for additional step pricing. This value is related to step cost and both options qualifiers should always be returned as a pair. - - Indicates the cost for the step size. i.e. 0.75 for each additional $ 100 coverage is StepSize=100 StepCost-0.75 - - When there is an up to amount included as part of the option the amount is returned in this field. i.e. If the first 100$ coverage is included IncludedAmount=100 - - If an option has a max value associated with the option the value will be returned in the response. - - If the option or adjustment is based on a percentage value the percentage will be returned - - Indicates that the option is included at no charge. - - If an option value is based on a per piece price the value is returned. - - - - Indicates the size class for the restriction block. Some products have size classes like SMALL, MEDIUM, LARGE, OS etc For Distr products this is only applicable for Pre Paids. If a size class code is provided that is not applicable for the product in question an error message will be returned for all products where it is not applicable. - - Item Dimensions. If dimensions are provided incorrectly wrt order an error response will be produced. - - - - - - Fully qualified Product Code. e.g. DOM.XP, DOM.PUB, DOM.AA, DOM.UA, DOM.LM.INC, INT.XP etc. For distribution requests this can be null. All applicable products will be priced in this case. - - Some discount elements are product specific. If a discount element is specified for a non applicable product an error may be returned. - - Province where the mailing will be inducted. Rate shopping requests are limited to a single province deposit. - - Prep type code for the rate request. Optional element. LCP, NDG If a prep type code is supplied that is not applicable for the product in question an error will be returned. - - If a presort type (i.e. DMD, DCF) code is supplied that is not applicable for the product in question an error will be returned. - - If a Destination Scope type (i.e. LOC, REG, NAT) code is supplied that is not applicable for the product in question an error will be returned. - - - - A rate response section will exist for all applicable Size Class, Presort and PrepType combinations - - - - - Size class code selected based on Mail item input or size class submitted. - - The Presort code used to determine the article. - - The preptype code used to determine the article. - - The destination scope code used to determine the article. - - - - This section required for DOM.AA,DOM.CAT,DOM.LM.INC and DOM.PUB. Indicates the Address Accuracy level for the address list used in the mailing. - - - - Continuous inbound Freight indicator used in tax calculation. Used for Unaddressed, Pubs, Addressed Admail - - Publication registration ID. When provided the funded indicator will be set on the order to be rated. - - - Customer Info or Price Level can be provided to determine the Price Level to be used for COMMERICIAL Rating. If neither is provided SBR rates will be used. - - The Price Level to be used for Rating. Applies only to COMMERCIAL Mailings. If CONSUMER rates were requested and a price level is provided this would result in an inconsistent rate request. - - Supports INTERLINER - - - - - - - - Fully qualified Product Code. e.g. DOM.XP, DOM.PUB, DOM.AA, DOM.UA, DOM.LM.INC, INT.XP etc. For distribution requests this can be null. All applicable products will be priced in this case. - - Identifies origin of mailing. Only FSA is required but LDU should be provided to ensure most accurate rates. - - - One of NAT, REG, INT, USA Only applies to certain products where pricing can be completed without a specific destination. i.e. Prepaids - - Identified destination - - - - - - - - - (CONSUMER, COMMERCIAL) - - Optional element. If included commercial rates will apply. If ChannetTypeCode=CONSUMER and a valid customer number (and Contract number are provided) the service will respond with an error indicating an inconsistent request. - - One of (EORDERFF, EORDER) EORDER Triggers Discount for Distribution Orders and avoids a Manual surcharge for Communications Orders. EORDERFF is applicable for Communications products only and ensures that no Manual surcharge is applied and that an additional Discount is included. - - One of (INCLUDEPRICESTEPS, INCLUDEFREEWEIGHT, INCLUDETAXRATEINFO). INCLUDEPRICESTEPS - triggers the inclusion of price per piece weight steps in the rating response. For Publications mailings with samples. (i.e. PUB.SAMPLE.MULI, PUB.SAMPLE.SINGLE)When the price steps are requested the sample weight submitted in the request will be ignored and treated as a zero weight. INCLUDEFREEWEIGHT - triggers the inclusion of freeweight result in the rate response (Distribution Products Only). INCLUDETAXRATEINFO - triggers the inclusion of tax rate information (GST, PST, or HST percent) in the rating response. - - The Mailing Date. This is a mandatory field used to determines the rates in effect for the specified date. Doc entry 2 - - Item quantity. The total price returned will take the quantity into consideration. If not provided the value is defaulted to 1. If a value of 0 is provided the rating will return option prices, price per piece total etc but the base price, taxes and total due will all be zero. - - A set of options to be priced. All options in this list will be included in the totals. Both Order level options and item level options are permitted. eg plate change, signature, etc Since the request can specify multiple products some options may not be applicable to certain products. In this case the non applicable option will not be priced - nil result. - - A set of options to be priced priced separately in the response. These options will not be included in the totals. - - Dimensions and weight details for mailing item. - - - - - - - Canada post customer number. Owner of the contract - - The contract number to use to determine the contracted rate. If a contract specific rate is not found for the product in question then SBR rates will be used. - - - - Rating indicators - - - - Rating indicators - - - - - - - - - Length in cm. Length is defined as the longest dimension. - - - - Width in cm. Width is defined as the second longest dimension. - - - - Height in cm. Height is defined as the shortest dimension - - - - - - - - - - - - US State code of the destination. - - The zip code is optional but may pricing may be different if specified since rating can be specific for certain zip codes. - - - - If Option requires an qualifier the value would be included as an element. i.e. Code=COV required an amount - - - - - - Option Code eg, COV, COD - - Price for the Option/Adjustment - - Set of additional qualifiers for the option in questions - - - - The Total Amount Due. This is equal to the Base + Taxes + Options (Selected=True) + Adjustments - - Base Total for Product or Service - - Applicable taxes for the rate request - - Options included in the request - - Adjustments - Fees and Discounts. Discounts will be negative numbers. - - Unselected options that were requested for pricing. Each option in the request set will be priced in consideration with the selected option set. - - This optional response section will be included when INCLUDEPRICESTEPS handling indicator is set in the request. This is currently only supported for PUB.SAMPLE.MULTI and PUB.SAMPLE.SINGLE - - - - - - - - - Good and Services Tax - - - - - Provincial sales tax - - - - - Harmonized sales tax - - - - - - - Indicates that AM delivery applies - - Indicates if there is a guaranteed on the Max days - - Max service standard in days - - Min service standard in Days - - Internationalized description - - - - - - English Language Description of Error condition - - Placeholder for additional error text for debugging purposes - - Offending name value pairs. - - Error Code - - - - English Language Description of Error condition - - Placeholder for additional error text for debugging purposes - - Offending name value pairs. - - Error Code - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -