Documentation

ShipmentItem

\Bitrix\Sale\ShipmentItem is a shipment item class. Class also implements interface \IEntityMarker.


Inheritance chain

\Bitrix\Sale\ShipmentItem > \Bitrix\Sale\Internals\CollectableEntity > \Bitrix\Sale\Internals\Entity

Class methods

MethodDescription Available from version
create Creates a shipment item and associates collection with it.
getBasketCode Returns product code.
getBasketId Returns product ID.
getBasketItem Returns a product.
getProductId Returns product's PRODUCT_ID.
getQuantity Returns number of products in shipment.
getRegistryType Returns register type associated with an object.
getReservedQuantity Returns reserved amount of product included into a shipment.
getShipmentItemStoreCollection Returns warehouses with distributed product for a shipment.
isChanged Checks for object updates.
loadForShipment Returns product within a shipment by its ID.
setQuantity Sets amount of product included into a shipment.
verify Verifies a shipment.

Methods for parent class Bitrix\Sale\Internals\CollectableEntity

MethodDescription Available from version
createCloneClones this item.
deleteDeletes an item.
doFinalActionExecutes finalizing actions.
getCollectionReturns collection with associated item.
getInternalIndexReturns internal index for a collection item.
isCloneChecks if this item is a clone.
setCollectionAssociates collection to an item.

Methods for parent class \Bitrix\Sale\Internals\Entity

MethodDescription Available from version
doFinalActionAbstract method, designed to implement "final" calculation logic.
getAvailableFieldsReturns array of fields to be set via methods setField() and setFields().
getAvailableFieldsMapReturns array of fields to be set via the methods setField() and setFields(). getAvailableFields values are used as array keys.
getFieldReturns value for $name field.
getFieldValuesReturns array of fields with values.
getIdReturns entity ID.
initFieldInitializes field by a value. Object is not considered as updated.
initFieldsInitializes fields by values. Object is not considered as updated.
isChangedChecks, if entity was updated. If yes, returns true, otherwise returns false.
isMathActionOnlyChecks, if current data is used for calculations (provider data is not requested). If yes, returns true, otherwise returns false.
setFieldSets values for the field $name.
setFieldsInitializes fields by values. Object is not considered as updated.
setMathActionOnlyDisables requests to provider when during calculations.
verifyChecks, if object is correct. Returns object \Bitrix\Sale\Result.


© «Bitrix24», 2001-2022
Up