Bitrix API

HandlerBase

AbstractYes

Class HandlerBase

Table of Contents

Constants

CANCEL_ACTION_CODE  = 'CANCEL'

Methods

__construct()  : mixed
Base constructor.
addShipments()  : Result
Add shipments to delivery request
create()  : Result
Creates delivery request.
delete()  : Result
Delete delivery request
deleteShipments()  : Result
Delete shipment from delivery request
executeAction()  : Result
Executes delivery request action
executeShipmentAction()  : Result
Executes action for shipment from delivery request
getActions()  : array<string|int, mixed>
getCancelActionCode()  : string
getCancelActionName()  : string
getContent()  : Result
Returns content of delivery request
getFormFields()  : array<string|int, mixed>
Returns array of fields if we need some additional information during creation, or action execution, etc.
getHandlingDeliveryServiceId()  : int
Returns id of delivery service witch actually handles delivery requests
getShipmentActions()  : array<string|int, mixed>
getShipmentContent()  : mixed
Returns content of shipment from delivery request
hasCallbackTrackingSupport()  : bool
updateShipments()  : Result
Update shipment from delivery request

Constants

CANCEL_ACTION_CODE

public mixed CANCEL_ACTION_CODE = 'CANCEL'

Methods

__construct()

Base constructor.

public __construct(Base $deliveryService) : mixed
Parameters
$deliveryService : Base

addShipments()

Add shipments to delivery request

public addShipments(int $requestId, array<string|int, int> $shipmentIds[, array<string|int, mixed> $additional = [] ]) : Result
Parameters
$requestId : int
$shipmentIds : array<string|int, int>
$additional : array<string|int, mixed> = []
Return values
Result

create()

Creates delivery request.

public create(array<string|int, int> $shipmentIds[, array<string|int, mixed> $additional = [] ]) : Result
Parameters
$shipmentIds : array<string|int, int>
$additional : array<string|int, mixed> = []
Return values
Result

delete()

Delete delivery request

public delete(int $requestId) : Result
Parameters
$requestId : int
Return values
Result

deleteShipments()

Delete shipment from delivery request

public deleteShipments(int $requestId[, array<string|int, int> $shipmentIds = [] ]) : Result
Parameters
$requestId : int
$shipmentIds : array<string|int, int> = []
Return values
Result

executeAction()

Executes delivery request action

public executeAction(int $requestId, string $actionType, array<string|int, mixed> $additional) : Result
Parameters
$requestId : int
$actionType : string
$additional : array<string|int, mixed>
Return values
Result

executeShipmentAction()

Executes action for shipment from delivery request

public executeShipmentAction(int $requestId, int $shipmentId, string $actionType, array<string|int, mixed> $additional) : Result
Parameters
$requestId : int
$shipmentId : int
$actionType : string
$additional : array<string|int, mixed>
Return values
Result

getActions()

public getActions(int|null $requestId) : array<string|int, mixed>
Parameters
$requestId : int|null
Return values
array<string|int, mixed> —

Actions list. For example array( 'ACTION1' => 'ACTION1_NAME', 'ACTION2' => 'ACTION2_NAME').

getCancelActionCode()

public getCancelActionCode() : string
Return values
string

getCancelActionName()

public getCancelActionName() : string
Return values
string

getContent()

Returns content of delivery request

public getContent(int $requestId) : Result
Parameters
$requestId : int
Return values
Result

getFormFields()

Returns array of fields if we need some additional information during creation, or action execution, etc.

public getFormFields(string $formFieldsType, array<string|int, int> $shipmentIds[, array<string|int, mixed> $additional = [] ]) : array<string|int, mixed>
Parameters
$formFieldsType : string

(FORM_FIELDS_TYPE_CREATE | FORM_FIELDS_TYPE_ADD | FORM_FIELDS_TYPE_ACTION)

$shipmentIds : array<string|int, int>
$additional : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getHandlingDeliveryServiceId()

Returns id of delivery service witch actually handles delivery requests

public getHandlingDeliveryServiceId() : int
Return values
int

getShipmentActions()

public getShipmentActions(Shipment $shipment) : array<string|int, mixed>
Parameters
$shipment : Shipment
Return values
array<string|int, mixed> —

Actions list For example array( 'ACTION1' => 'ACTION1_NAME', 'ACTION2' => 'ACTION2_NAME').

getShipmentContent()

Returns content of shipment from delivery request

public getShipmentContent(int $requestId, int $shipmentId) : mixed
Parameters
$requestId : int
$shipmentId : int
Tags
@return

Result. Data contain array of shipment fields on delivery side

hasCallbackTrackingSupport()

public hasCallbackTrackingSupport() : bool
Return values
bool

updateShipments()

Update shipment from delivery request

public updateShipments(int $requestId[, array<string|int, int> $shipmentIds = [] ]) : Result
Parameters
$requestId : int
$shipmentIds : array<string|int, int> = []
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results