ShipmentCollection

\Bitrix\Sale\ShipmentCollection class for collection of shipments

\Bitrix\Sale\ShipmentCollection > \Bitrix\Sale\Internals\EntityCollection > \Bitrix\Sale\Internals\CollectionBase

Method	Description	Available from version
allowDelivery	Allows order delivery.
calculateDelivery	Calculates delivery cost for an individual shipment.
createItem	Creates a new shipment.
disallowDelivery	Denies order delivery.
getBasePriceDelivery	Returns delivery cost for all shipments without discounts and extra charges.
getBasketItemDistributedQuantity	Resets estimated cost for deliveries.
getItemByShipmentCode	Returns shipment by its code.
getOrder	Returns order with associated collection.
getPriceDelivery	Returns delivery cost for all shipments with discounts and extra charges.
getRegistryType	Returns register type for an object.
getSystemShipment	Returns a system shipment.
hasAllowDelivery	Checks if order has shipments with allowed delivery.
hasShipped	Checks if order has shipments that were shipped.
isAllowDelivery	Checks if shipment delivery is allowed.
isExistBasketItem	Checks if product is distributed by shipments.
isMarked	Checks for existing shipments marked as containing errors.
isReserved	Checks if order is reserved.
isShipped	Checks if order was shipped.
load	Returns order with associated collection.
refreshData	Recalculates deliveries for all shipments.
resetCollection	Clears collection of shipments.
resetData	Resets estimated delivery cost.
setOrder	Associates order to a collection.
verify	Verifies shipments.

Method	Description	Available from version
clearCollection	Deletes all collection items.
doFinalAction	Executes final actions.
getIndexById	Searches item in collection by ID and returns its internal index.
getItemById	Searches item in collection by ID and returns it.
getItemByIndex	Searches item in collection by internal index and returns it.
isAnyItemDeleted	Checks if a collection item was deleted.
isChanged	Checks if collection was updated. Returns `true` or `false`.
isClone	Checks if collection was cloned. Returns `true` or `false`.
verify	Verifies collection validly. Returns object `\Bitrix\Sale\Result`.

Method	Description	Available from version
count	Returns number of object items.
current	Returns current item.
getIterator	Returns external iterator.
isEmpty	Checks collection for emptiness. When collection doesn't contain any items, returns `true` (otherwise, `false`).
key	Returns index for current collection item.
next	Moves collection selection to the next item.
offsetExists	Defines, if specified offset exists (key).
offsetGet	Returns specified offset (key).
offsetSet	Sets value for this offset.
offsetUnset	Resets offset value.
rewind	Rewinds selection to the first collection item.
valid	Checks, if collection contains valid items.