Bitrix API

ShipmentResult extends Result

Class ShipmentResult

Table of Contents

Methods

__clone()  : mixed
__construct()  : mixed
ShipmentResult constructor.
addError()  : $this
Adds the error.
addErrors()  : $this
Adds array of Error objects
addMessage()  : mixed
addMessages()  : $this
Adds array of Message objects
addResult()  : mixed
addResults()  : mixed
getData()  : array<string|int, mixed>
Returns data array saved into the result.
getDeliveryDocDate()  : string
getDeliveryDocNum()  : string
getError()  : Error|null
Returns the Error object.
getErrorCollection()  : ErrorCollection
Returns the error collection.
getErrorMessages()  : array<string|int, string>
Returns array of strings with error messages
getErrors()  : array<string|int, Error>
Returns an array of Error objects.
getExternalId()  : string
getInternalId()  : int
getMessages()  : array<string|int, Message>
getMessagesCollection()  : array<string|int, mixed>|MessagesCollection
getMessagesMessages()  : array<string|int, mixed>
getRequestResults()  : array<string|int, RequestResult>
getResults()  : array<string|int, mixed>
getShipmentResults()  : array<string|int, ShipmentResult>
getTrackingNumber()  : string
isSuccess()  : bool
Returns the result status.
setData()  : $this
Sets data of the result.
setDeliveryDocDate()  : mixed
setDeliveryDocNum()  : mixed
setExternalId()  : mixed
setInternalId()  : mixed
setResults()  : mixed
setTrackingNumber()  : mixed

Methods

__clone()

public __clone() : mixed

__construct()

ShipmentResult constructor.

public __construct(int $internalId[, string $externalId = '' ]) : mixed
Parameters
$internalId : int
$externalId : string = ''

addError()

Adds the error.

public addError(Error $error) : $this
Parameters
$error : Error
Return values
$this

addErrors()

Adds array of Error objects

public addErrors(array<string|int, Error> $errors) : $this
Parameters
$errors : array<string|int, Error>
Return values
$this

addMessages()

Adds array of Message objects

public addMessages(array<string|int, Message> $messages) : $this
Parameters
$messages : array<string|int, Message>
Return values
$this

addResults()

public addResults(array<string|int, Result> $results) : mixed
Parameters
$results : array<string|int, Result>

getData()

Returns data array saved into the result.

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDeliveryDocDate()

public getDeliveryDocDate() : string
Return values
string

getDeliveryDocNum()

public getDeliveryDocNum() : string
Return values
string

getError()

Returns the Error object.

public getError() : Error|null
Return values
Error|null

getErrorMessages()

Returns array of strings with error messages

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

getErrors()

Returns an array of Error objects.

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getExternalId()

public getExternalId() : string
Return values
string

getMessages()

public getMessages() : array<string|int, Message>
Return values
array<string|int, Message>

getMessagesMessages()

public getMessagesMessages() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResults()

public getResults() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTrackingNumber()

public getTrackingNumber() : string
Return values
string

isSuccess()

Returns the result status.

public isSuccess() : bool
Return values
bool

setData()

Sets data of the result.

public setData(array<string|int, mixed> $data) : $this
Parameters
$data : array<string|int, mixed>
Return values
$this

setDeliveryDocDate()

public setDeliveryDocDate(string $deliveryDocDate) : mixed
Parameters
$deliveryDocDate : string

setDeliveryDocNum()

public setDeliveryDocNum(string $deliveryDocNum) : mixed
Parameters
$deliveryDocNum : string

setExternalId()

public setExternalId(string $externalId) : mixed
Parameters
$externalId : string

setInternalId()

public setInternalId(int $internalId) : mixed
Parameters
$internalId : int

setResults()

public setResults(array<string|int, mixed> $results) : mixed
Parameters
$results : array<string|int, mixed>

setTrackingNumber()

public setTrackingNumber(string $trackingNumber) : mixed
Parameters
$trackingNumber : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results