Pricing pipelines
GetProductPrices pipeline
Name: |
GetProductPrices | |
Description: |
Gets the price object that matches the specified criteria. This pipeline is responsible for reading pricing data from a commerce system. This pipeline requests product pricing information from the commerce system and then converts the output into the proper Connect format. | |
Usage: |
Called by the Pricing service provider. | |
Args Parameters: | ||
RequestResponseshell
|
Includes the search criteria. Is set by the Pricing service provider prior to calling the pipeline. | |
RequestResponseshell
|
Includes the price collection object. Is read by the Pricing service provider after the pipeline is called. | |
Processors: | ||
GetProductPrices |
Retrieves the prices specified by |
GetProductBreakPrices pipeline
Name: |
GetProductBreakPrices | |
Description: |
Gets the break price objects with corresponding conditions that match the specified criteria. This pipeline is responsible for reading break pricing data from a commerce system. This pipeline requests product pricing information from the commerce system and then converts the output into the proper Connect format. | |
Usage: |
Called by the Pricing service provider. | |
Args Parameters: | ||
RequestResponseshell
|
Includes the search criteria. Is set by the Pricing service provider prior to calling the pipeline. | |
RequestResponseshell
|
Includes the price collection object. Is read by the Pricing service provider after the pipeline is called. | |
Processors: | ||
|
Where multiple prices exist for the product, determines which price applies. With break prices, several prices must be returned and conditions created. It is the responsibility of this processor to build the conditions with the associated prices. For more info, see the definition of the condition. |
GetCartTotals pipeline
Name: |
GetCartTotals | |
Description: |
Gets the totals object that matches the specified criteria. This pipeline is responsible for reading pricing data from a commerce system. This pipeline converts the contents of a Connect cart into a format the commerce system can understand, requests that the commerce system calculate the totals, and then converts the output into the proper Connect format. | |
Usage: |
Called by the Pricing service provider. | |
Args Parameters: | ||
RequestResponseshell
|
Includes the search criteria. Is set by the Pricing service provider prior to calling the pipeline. | |
RequestResponseshell
|
Includes the totals for the cart. Is read by the Pricing service provider after the pipeline is called. | |
Processors: | ||
|
Adjustments represent charges or discounts that need to be resolved and applied. For example, discount codes/promotions, and special charges for products. | |
|
Taxes might be calculated by a separate service. | |
|
Shipping might be calculated by a separate service. | |
|
Makes the final calculations based on the content of the cart. |
GetSupportedCurrencies pipeline
Name: |
GetSupportedCurrencies | |
Description: |
Gets the list of supported currencies from the ECS. | |
Usage: |
Called by the Pricing service provider. | |
Args Parameters: | ||
RequestResponseshell
|
Includes the current shop name. Is set by the Pricing service provider prior to calling the pipeline. | |
RequestResponseshell
|
Includes the list of available currencies. Is read by the Pricing service provider after the pipeline is called. | |
Processors: | ||
|
A placeholder processor that should be replaced with a custom processor that communicates with the ECS. |
CurrencyChosen pipeline
Name: |
CurrencyChosen | |
Description: |
Used to raise the Currency Chosen page event when the visitor changes the selected currency | |
Usage: |
Called by the Pricing service provider. | |
Args Parameters: | ||
RequestResponseshell
|
Includes the shop name and chosen currency. Is set by the Pricing service provider prior to calling the pipeline. | |
RequestResponseshell
|
No data is returned. Is read by the Pricing service provider after the pipeline is called. | |
Processors: | ||
|
Raises the Currency Chosen event |
GetEligiblePromotionIds pipeline
Name: |
commerce.prices.getEligiblePromotionIds | |
Description: |
Used to retrieve a list of promotions that are eligible for a product. | |
Usage: |
Called by the Pricing service provider. | |
Parameters: | ||
RequestResponseshell
|
A GetEligiblePromotionIdsRequest that includes the shop name and the ID of the product for which promotions are being retrieved. | |
RequestResponseshell
|
A GetEligiblePromotionIdsResult that contains the IDs of the promotions that are eligible for the product. | |
Processors: | ||
<none> - |
There is no default implementation for this pipeline. The external commerce system must provide processors for this pipeline. |
GetProductPromotionDescription pipeline
Name: |
commerce.prices.getProductPromotionDescription | |
Description: |
Used to retrieve the description of promotions. | |
Usage: |
Called by the Pricing service provider. | |
Parameters: | ||
RequestResponseshell
|
A GetProductPromotionDescriptionRequest that includes the shop name and the IDs of the promotions to retrieve. | |
RequestResponseshell
|
A GetProductPromotionDescriptionResult that contains the descriptions of the requested promotions. | |
Processors: | ||
<none> - |
There is no default implementation for this pipeline. The external commerce system must provide processors for this pipeline. |