Documentation

Order component events

Note: starting from Online Store module version 16.0.31, added new option for recalculating order after events are updated by flag RECREATE_ORDER.

EventDescription and parameters Available from version
OnSaleComponentOrderCreated Called after creating and calculating order object.

Parameters
$order Order object \Bitrix\Sale\Order.
&$arUserResult Component array arUserResult, contains current selected user data.
$request Object \Bitrix\Main\HttpRequest.
&$arParams Array of component parameters.
&$arResult Component array arResult.
&$arDeliveryServiceAll Array of delivery services available as per restrictions.
&$arPaySystemServiceAll Array of payment systems, available as per restrictions.
OnSaleComponentOrderShowAjaxAnswer Called before sending Ajax-response.

Parameters
&$result Array of data for Ajax response.
OnSaleComponentOrderJsData Called after initializing array with data for javascript handler.

Parameters
&$arResult Component array arResult.
&$arParams Array with component array.
OnSaleComponentOrderProperties Called after getting all order properties (from default values, from profile or already filled in by the customer).

Parameters
&$arUserResult Component array arUserResult, containing current selected user data.
$request Object \Bitrix\Main\HttpRequest.
&$arParams Array with component parameters.
&$arResult Component array arResult.
OnSaleComponentOrderUserResult Called after getting data (properties for order, payment system, delivery service and etc.) sent by client.

Parameters
&$arUserResult Component array arUserResult, containing current selected user data.
$request Object \Bitrix\Main\HttpRequest.
&$arParams Array with component parameters.
OnSaleComponentOrderDeliveriesCalculated Called after calculating delivery service charges.

Parameters
$order Object for order \Bitrix\Sale\Order.
&$arUserResult Component array arUserResult, containing current selected user data.
$request Object \Bitrix\Main\HttpRequest.
&$arParams Array with component parameters.
&$arResult Component array arResult.
&$arDeliveryServiceAll Array with delivery services available as per restrictions.
&$arPaySystemServiceAll Array with payment systems available as per restrictions.
OnSaleComponentOrderResultPrepared Called after generating all component data at the order form completing stage. Can be used for modifying the data. Equivalent to legacy event OnSaleComponentOrderOneStepProcess.

Parameters
$order Object for order \Bitrix\Sale\Order.
&$arUserResult Component array arUserResult, containing current selected user data.
$request Object \Bitrix\Main\HttpRequest.
&$arParams Array with component parameters.
&$arResult Component array arResult.


© «Bitrix24», 2001-2023
Up