Bitrix API

Shipment extends CollectableEntity implements IBusinessValueProvider, IEntityMarker

Class Shipment

Table of Contents

Interfaces

IBusinessValueProvider
IEntityMarker
Bitrix Framework

Methods

allowDelivery()  : Result
calculateDelivery()  : CalculationResult
canAutoFixError()  : bool
canMarked()  : bool
clearStartField()  : bool
create()  : mixed
delete()  : Result
Deletes shipment
deliver()  : Result
disallowDelivery()  : Result
doFinalAction()  : Result
fixReserveErrors()  : Result
fixShipErrors()  : Result
getAllFields()  : array<string|int, mixed>
getAllowDeliveryDate()  : DateTime
getAllowDeliveryUserId()  : int
getAutoFixErrorsList()  : array<string|int, mixed>
getAvailableFields()  : array<string|int, mixed>
getAvailableFieldsMap()  : array<string|int, mixed>|null
getBasketItemQuantity()  : float|int
getBusinessValueProviderInstance()  : Shipment|null|string
getClassName()  : string
getCollection()  : EntityCollection
getCompanyId()  : int
getCurrency()  : string
getCustomizableFields()  : array<string|int, mixed>
getDelivery()  : Base
getDeliveryId()  : int
getDeliveryName()  : string
getErrorEntity()  : string
getExtraServices()  : array<string|int, mixed>
getExtraServicesObjects()  : array<string|int, Base>
getField()  : string|null
getFieldsDescription()  : array<string|int, mixed>
getFieldValues()  : array<string|int, mixed>
getId()  : int
getInternalIndex()  : null|int
getList()  : Result
getMarkField()  : string
getOrder()  : Order|null
getParentOrder()  : Order|null
getParentOrderId()  : bool|int
getPersonTypeId()  : int|null
getPrice()  : float
getPropertyCollection()  : ShipmentPropertyValueCollection
getRegistryEntity()  : string|void
getRegistryType()  : string
getServiceParams()  : array<string|int, mixed>
getShipmentCode()  : int
getShipmentItemCollection()  : array<string|int, mixed>|ShipmentItemCollection
getShippedDate()  : DateTime
getShippedUserId()  : int
getStoreId()  : int
getUfId()  : null
getUnshipReason()  : string
getVatRate()  : float|int
getVatSum()  : float
getWeight()  : float
hasMeaningfulField()  : bool
isAllowDelivery()  : bool
isCanceled()  : bool
isChanged()  : bool
isClone()  : bool
isCustomPrice()  : bool
isEmpty()  : bool
isExistBasketItem()  : bool
isMarked()  : bool
isMarkedFieldCustom()  : bool
isMathActionOnly()  : bool
isReserved()  : bool
isShipped()  : bool
isStartField()  : bool
isSystem()  : bool
loadForOrder()  : array<string|int, mixed>
loadPropertyCollection()  : ShipmentPropertyValueCollection
markFieldCustom()  : mixed
needShip()  : mixed
onBasketModify()  : Result
onBeforeBasketItemDelete()  : Result
onShipmentItemCollectionModify()  : Result
resetData()  : mixed
setAccountNumber()  : Result
setBasePriceDelivery()  : Result
setCollection()  : mixed
setDeliveryService()  : mixed
setExtraServices()  : mixed
setField()  : Result
Sets new value to specified field of shipment item
setFields()  : Result
setMathActionOnly()  : bool
setOrderId()  : mixed
setServiceParams()  : mixed
setStoreId()  : mixed
setWeight()  : string|null
toArray()  : array<string|int, mixed>
tryFixError()  : Result
tryReserve()  : mixed
tryShip()  : Result
tryUnreserve()  : mixed
tryUnship()  : Result
unmarkFieldCustom()  : mixed
updateReservedFlag()  : Result
verify()  : Result

Methods

allowDelivery()

public allowDelivery() : Result
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
Return values
Result

canAutoFixError()

public canAutoFixError(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

canMarked()

public canMarked() : bool
Return values
bool

delete()

Deletes shipment

public delete() : Result
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
throws
Exception
Return values
Result

deliver()

public deliver() : Result
Tags
throws
ObjectNotFoundException
Return values
Result

disallowDelivery()

public disallowDelivery() : Result
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
Return values
Result

doFinalAction()

public doFinalAction([mixed $hasMeaningfulField = false ]) : Result
Parameters
$hasMeaningfulField : mixed = false
Return values
Result

fixReserveErrors()

public static fixReserveErrors(Shipment $entity) : Result
Parameters
$entity : Shipment
Tags
throws
ObjectNotFoundException
Return values
Result

fixShipErrors()

public static fixShipErrors(Shipment $entity) : Result
Parameters
$entity : Shipment
Tags
throws
ObjectNotFoundException
Return values
Result

getAllFields()

public static getAllFields() : array<string|int, mixed>
Tags
throws
NotImplementedException
Return values
array<string|int, mixed>

getAllowDeliveryUserId()

public getAllowDeliveryUserId() : int
Return values
int

getAutoFixErrorsList()

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

getAvailableFields()

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

getAvailableFieldsMap()

public static getAvailableFieldsMap() : array<string|int, mixed>|null
Tags
throws
NotImplementedException
Return values
array<string|int, mixed>|null

getBasketItemQuantity()

public getBasketItemQuantity(BasketItem $basketItem) : float|int
Parameters
$basketItem : BasketItem
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ObjectNotFoundException
Return values
float|int

getBusinessValueProviderInstance()

public getBusinessValueProviderInstance(mixed $mapping) : Shipment|null|string
Parameters
$mapping : mixed
Return values
Shipment|null|string

getClassName()

public static getClassName() : string
Return values
string

getCompanyId()

public getCompanyId() : int
Return values
int

getCurrency()

public getCurrency() : string
Return values
string

getCustomizableFields()

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

getDelivery()

public getDelivery() : Base
Tags
throws
ArgumentNullException
throws
SystemException
Return values
Base

getDeliveryId()

public getDeliveryId() : int
Return values
int

getDeliveryName()

public getDeliveryName() : string
Return values
string

getErrorEntity()

public getErrorEntity(mixed $value) : string
Parameters
$value : mixed
Return values
string

getExtraServices()

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

getExtraServicesObjects()

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

getField()

public getField(mixed $name) : string|null
Parameters
$name : mixed
Return values
string|null

getFieldsDescription()

public static getFieldsDescription() : array<string|int, mixed>
Tags
throws
NotImplementedException
Return values
array<string|int, mixed>

getFieldValues()

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

getId()

public getId() : int
Return values
int

getInternalIndex()

public getInternalIndex() : null|int
Return values
null|int

getList()

public static getList(array<string|int, mixed> $parameters) : Result
Parameters
$parameters : array<string|int, mixed>
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

getMarkField()

public getMarkField() : string
Return values
string

getParentOrder()

public getParentOrder() : Order|null

Use getOrder instead

Return values
Order|null

getParentOrderId()

public getParentOrderId() : bool|int
Return values
bool|int

getPersonTypeId()

public getPersonTypeId() : int|null
Return values
int|null

getPrice()

public getPrice() : float
Return values
float

getRegistryEntity()

public static getRegistryEntity() : string|void
Return values
string|void

getRegistryType()

public static getRegistryType() : string
Return values
string

getServiceParams()

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

getShipmentCode()

public getShipmentCode() : int
Return values
int

getShipmentItemCollection()

public getShipmentItemCollection() : array<string|int, mixed>|ShipmentItemCollection
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ObjectNotFoundException
Return values
array<string|int, mixed>|ShipmentItemCollection

getShippedUserId()

public getShippedUserId() : int
Return values
int

getStoreId()

public getStoreId() : int
Return values
int

getUfId()

public static getUfId() : null
Return values
null

getUnshipReason()

public getUnshipReason() : string
Return values
string

getVatRate()

public getVatRate() : float|int
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
float|int

getVatSum()

public getVatSum() : float
Tags
throws
ArgumentNullException
throws
LoaderException
Return values
float

getWeight()

public getWeight() : float
Return values
float

isAllowDelivery()

public isAllowDelivery() : bool
Return values
bool

isCanceled()

public isCanceled() : bool
Return values
bool

isChanged()

public isChanged() : bool
Return values
bool

isCustomPrice()

public isCustomPrice() : bool
Tags
throws
ArgumentOutOfRangeException
Return values
bool

isEmpty()

public isEmpty() : bool
Return values
bool

isExistBasketItem()

public isExistBasketItem(BasketItem $basketItem) : bool
Parameters
$basketItem : BasketItem
Tags
throws
ObjectNotFoundException
Return values
bool

isMarked()

public isMarked() : bool
Return values
bool

isMarkedFieldCustom()

public isMarkedFieldCustom(string $name) : bool
Parameters
$name : string
Return values
bool

isReserved()

public isReserved() : bool
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ObjectNotFoundException
Return values
bool

isShipped()

public isShipped() : bool
Return values
bool

isStartField()

public isStartField([bool $isMeaningfulField = false ]) : bool
Parameters
$isMeaningfulField : bool = false
Return values
bool

isSystem()

public isSystem() : bool
Return values
bool

loadForOrder()

public static loadForOrder(mixed $id) : array<string|int, mixed>
Parameters
$id : mixed
Tags
throws
ArgumentException
throws
ArgumentNullException
Return values
array<string|int, mixed>

markFieldCustom()

public markFieldCustom(string $name) : mixed
Parameters
$name : string
Tags
throws
ArgumentOutOfRangeException

onBasketModify()

public onBasketModify(mixed $action, BasketItem $basketItem[, null $name = null ][, null $oldValue = null ][, null $value = null ]) : Result
Parameters
$action : mixed
$basketItem : BasketItem
$name : null = null
$oldValue : null = null
$value : null = null
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
throws
SystemException
Return values
Result

onBeforeBasketItemDelete()

public onBeforeBasketItemDelete(BasketItem $basketItem) : Result
Parameters
$basketItem : BasketItem
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
throws
SystemException
Return values
Result

onShipmentItemCollectionModify()

public onShipmentItemCollectionModify(mixed $action, ShipmentItem $shipmentItem[, null $name = null ][, null $oldValue = null ][, null $value = null ]) : Result
Parameters
$action : mixed
$shipmentItem : ShipmentItem
$name : null = null
$oldValue : null = null
$value : null = null
Tags
throws
NotSupportedException
throws
SystemException
Return values
Result

resetData()

public resetData() : mixed
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException

setAccountNumber()

public setAccountNumber(mixed $id) : Result
Parameters
$id : mixed
Tags
throws
ObjectNotFoundException
throws
Exception
Return values
Result

setBasePriceDelivery()

public setBasePriceDelivery(mixed $value[, bool $custom = false ]) : Result
Parameters
$value : mixed
$custom : bool = false
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
Exception
Return values
Result

setDeliveryService()

public setDeliveryService(Base $service) : mixed
Parameters
$service : Base
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
Exception

setExtraServices()

public setExtraServices(array<string|int, mixed> $extraServices) : mixed
Parameters
$extraServices : array<string|int, mixed>

setField()

Sets new value to specified field of shipment item

public setField(string $name, mixed $value) : Result
Parameters
$name : string
$value : mixed
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
Exception
Return values
Result

setFields()

public setFields(array<string|int, mixed> $values) : Result
Parameters
$values : array<string|int, mixed>
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
Exception
Return values
Result

setMathActionOnly()

public setMathActionOnly([bool|false $value = false ]) : bool
Parameters
$value : bool|false = false
Return values
bool

setOrderId()

public setOrderId(mixed $orderId) : mixed
Parameters
$orderId : mixed

setServiceParams()

public setServiceParams(array<string|int, mixed> $serviceParams) : mixed
Parameters
$serviceParams : array<string|int, mixed>
Tags
throws
NotSupportedException

setStoreId()

public setStoreId(int $storeId) : mixed
Parameters
$storeId : int

setWeight()

public setWeight(float $weight) : string|null
Parameters
$weight : float
Return values
string|null

toArray()

public toArray() : array<string|int, mixed>
Tags
throws
ArgumentException
throws
SystemException
Return values
array<string|int, mixed>

tryFixError()

public tryFixError(mixed $code) : Result
Parameters
$code : mixed
Return values
Result

tryReserve()

public tryReserve() : mixed
Tags
throws
ArgumentException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
Exception

tryShip()

public tryShip() : Result
Tags
throws
NotSupportedException
throws
ObjectNotFoundException
Return values
Result

tryUnreserve()

public tryUnreserve() : mixed
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
Exception

tryUnship()

public tryUnship() : Result
Tags
throws
NotSupportedException
throws
ObjectNotFoundException
Return values
Result

unmarkFieldCustom()

public unmarkFieldCustom(string $name) : mixed
Parameters
$name : string
Tags
throws
ArgumentOutOfRangeException

updateReservedFlag()

public static updateReservedFlag(Shipment $shipment) : Result
Parameters
$shipment : Shipment
Tags
throws
ObjectNotFoundException
Return values
Result

verify()

public verify() : Result
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ObjectNotFoundException
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results