Bitrix API

Manager

FinalYes

Class Manager

Table of Contents

Constants

EXTERNAL_STATUS_SEMANTIC_PROCESS  = 'process'
EXTERNAL_STATUS_SEMANTIC_SUCCESS  = 'success'
FORM_FIELDS_TYPE_ACTION  = 30
FORM_FIELDS_TYPE_ADD  = 20
FORM_FIELDS_TYPE_CREATE  = 10
MESSAGE_MANAGER_ADDRESSEE  = 'MANAGER'
MESSAGE_RECEIVED_EVENT_CODE  = 'OnDeliveryRequestMessageReceived'
MESSAGE_RECIPIENT_ADDRESSEE  = 'RECIPIENT'
REQUEST_ACTION_EXECUTED_EVENT_CODE  = 'OnDeliveryRequestActionExecuted'
REQUEST_CREATED_EVENT_CODE  = 'OnDeliveryRequestCreated'
REQUEST_DELETED_EVENT_CODE  = 'OnDeliveryRequestDeleted'
REQUEST_UPDATED_EVENT_CODE  = 'OnDeliveryRequestUpdated'
STATUS_PREPARED  = 0
STATUS_PROCESSED  = 20
STATUS_SENT  = 10

Methods

addShipmentsToDeliveryRequest()  : Result
createDeliveryRequest()  : Result
deleteDeliveryRequest()  : Result
deleteShipmentsFromDeliveryRequest()  : Result
executeDeliveryRequestAction()  : Result
executeDeliveryRequestShipmentAction()  : Result
getDeliveryRequestActions()  : array<string|int, mixed>
getDeliveryRequestContent()  : Result
getDeliveryRequestFormFields()  : array<string|int, mixed>
getDeliveryRequestHandlerByDeliveryId()  : HandlerBase|null
getDeliveryRequestShipmentActions()  : array<string|int, mixed>
getDeliveryRequestShipmentContent()  : Result
getMessageAddressees()  : array<string|int, string>
getRequestIdByShipmentId()  : int
getRequestStatusSemantics()  : array<string|int, string>
initJs()  : mixed
isShipmentSent()  : bool
onBeforeShipmentDelete()  : mixed
onBeforeShipmentSave()  : mixed
sendMessage()  : void
updateDeliveryRequest()  : Result
updateShipmentsFromDeliveryRequest()  : Result

Constants

EXTERNAL_STATUS_SEMANTIC_PROCESS

public mixed EXTERNAL_STATUS_SEMANTIC_PROCESS = 'process'

EXTERNAL_STATUS_SEMANTIC_SUCCESS

public mixed EXTERNAL_STATUS_SEMANTIC_SUCCESS = 'success'

FORM_FIELDS_TYPE_ACTION

public mixed FORM_FIELDS_TYPE_ACTION = 30

FORM_FIELDS_TYPE_ADD

public mixed FORM_FIELDS_TYPE_ADD = 20

FORM_FIELDS_TYPE_CREATE

public mixed FORM_FIELDS_TYPE_CREATE = 10

MESSAGE_MANAGER_ADDRESSEE

public mixed MESSAGE_MANAGER_ADDRESSEE = 'MANAGER'

MESSAGE_RECEIVED_EVENT_CODE

public mixed MESSAGE_RECEIVED_EVENT_CODE = 'OnDeliveryRequestMessageReceived'

MESSAGE_RECIPIENT_ADDRESSEE

public mixed MESSAGE_RECIPIENT_ADDRESSEE = 'RECIPIENT'

REQUEST_ACTION_EXECUTED_EVENT_CODE

public mixed REQUEST_ACTION_EXECUTED_EVENT_CODE = 'OnDeliveryRequestActionExecuted'

REQUEST_CREATED_EVENT_CODE

public mixed REQUEST_CREATED_EVENT_CODE = 'OnDeliveryRequestCreated'

REQUEST_DELETED_EVENT_CODE

public mixed REQUEST_DELETED_EVENT_CODE = 'OnDeliveryRequestDeleted'

REQUEST_UPDATED_EVENT_CODE

public mixed REQUEST_UPDATED_EVENT_CODE = 'OnDeliveryRequestUpdated'

STATUS_PREPARED

public mixed STATUS_PREPARED = 0

STATUS_PROCESSED

public mixed STATUS_PROCESSED = 20

STATUS_SENT

public mixed STATUS_SENT = 10

Methods

addShipmentsToDeliveryRequest()

public static addShipmentsToDeliveryRequest(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

createDeliveryRequest()

public static createDeliveryRequest(int $deliveryId, array<string|int, int> $shipmentIds[, array<string|int, mixed> $additional = array() ]) : Result
Parameters
$deliveryId : int
$shipmentIds : array<string|int, int>
$additional : array<string|int, mixed> = array()

Additional info required for creation. Depends on delivery service.

Tags
throws
ArgumentException
throws
ArgumentNullException
throws
SystemException
throws
Exception
Return values
Result

deleteDeliveryRequest()

public static deleteDeliveryRequest(int $requestId) : Result
Parameters
$requestId : int
Tags
throws
Exception
Return values
Result

deleteShipmentsFromDeliveryRequest()

public static deleteShipmentsFromDeliveryRequest(int $requestId, array<string|int, int> $shipmentIds) : Result
Parameters
$requestId : int
$shipmentIds : array<string|int, int>
Return values
Result

executeDeliveryRequestAction()

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

executeDeliveryRequestShipmentAction()

public static executeDeliveryRequestShipmentAction(int $requestId, int $shipmentId, string $actionType[, array<string|int, mixed> $additional = array() ]) : Result
Parameters
$requestId : int
$shipmentId : int
$actionType : string
$additional : array<string|int, mixed> = array()
Return values
Result

getDeliveryRequestActions()

public static getDeliveryRequestActions(int $requestId) : array<string|int, mixed>
Parameters
$requestId : int
Tags
throws
ArgumentNullException
Return values
array<string|int, mixed> —

Request actions

getDeliveryRequestContent()

public static getDeliveryRequestContent(int $requestId) : Result
Parameters
$requestId : int
Return values
Result

getDeliveryRequestFormFields()

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

FORM_FIELDS_TYPE_ACTION | FORM_FIELDS_TYPE_ADD | FORM_FIELDS_TYPE_CREATE

$shipmentIds : array<string|int, int>
$additional : array<string|int, mixed> = array()
Tags
throws
ArgumentNullException
Return values
array<string|int, mixed> —

Form fields

getDeliveryRequestHandlerByDeliveryId()

public static getDeliveryRequestHandlerByDeliveryId(int $deliveryId) : HandlerBase|null
Parameters
$deliveryId : int
Tags
throws
ArgumentNullException
throws
SystemException
Return values
HandlerBase|null —

Delivery request handler

getDeliveryRequestShipmentActions()

public static getDeliveryRequestShipmentActions(Shipment $shipment) : array<string|int, mixed>
Parameters
$shipment : Shipment
Tags
throws
ArgumentNullException
Return values
array<string|int, mixed> —

Shipment actions

getDeliveryRequestShipmentContent()

public static getDeliveryRequestShipmentContent(int $requestId, int $shipmentId) : Result
Parameters
$requestId : int
$shipmentId : int
Tags
throws
ArgumentException
Return values
Result

getMessageAddressees()

public static getMessageAddressees() : array<string|int, string>
Return values
array<string|int, string>

getRequestIdByShipmentId()

public static getRequestIdByShipmentId(int $shipmentId) : int
Parameters
$shipmentId : int
Return values
int —

Request ID

getRequestStatusSemantics()

public static getRequestStatusSemantics() : array<string|int, string>
Return values
array<string|int, string>

initJs()

public static initJs() : mixed

isShipmentSent()

public static isShipmentSent(int $shipmentId) : bool
Parameters
$shipmentId : int
Return values
bool

onBeforeShipmentDelete()

public static onBeforeShipmentDelete(Shipment &$shipment) : mixed
Parameters
$shipment : Shipment

onBeforeShipmentSave()

public static onBeforeShipmentSave(Order &$order, Shipment &$shipment) : mixed
Parameters
$order : Order
$shipment : Shipment

sendMessage()

public static sendMessage(string $addressee, Message $message, int $requestId, int $shipmentId) : void
Parameters
$addressee : string
$message : Message
$requestId : int
$shipmentId : int

updateDeliveryRequest()

public static updateDeliveryRequest(mixed $requestId, array<string|int, mixed> $fields[, bool $overwriteProperties = false ]) : Result
Parameters
$requestId : mixed
$fields : array<string|int, mixed>
$overwriteProperties : bool = false
Return values
Result

updateShipmentsFromDeliveryRequest()

public static updateShipmentsFromDeliveryRequest(int $requestId, array<string|int, int> $shipmentIds) : Result
Parameters
$requestId : int
$shipmentIds : array<string|int, int>
Tags
throws
Exception
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results