Shipment

\Bitrix\Sale\Shipment class for shipments. This class implements interfaces \Bitrix\Sale\IBusinessValueProvider and \IEntityMarker.

Inheritance chain

\Bitrix\Sale\Shipment > \Bitrix\Sale\Internals\CollectableEntity > \Bitrix\Sale\Internals\Entity

Class methods

Method	Description	Available from version
allowDelivery	доставку отгрузки.
calculateDelivery	Calculates delivery cost
create	Creates a shipment object and associates collection to it.
delete	Deletes a shipment from an order (only unpaid shipment can be deleted).
disallowDelivery	Cancels permission for shipping a delivery.
getAllowDeliveryDate	Returns date when delivery is allowed.
getAllowDeliveryUserId	Returns user ID who permitted a delivery.
getBasketItemQuantity	Returns number of products in a shipment.
getCompanyId	Returns company ID associated with shipment.
getCurrency	Returns shipment currency.
getDelivery	Returns a delivery service object.
getDeliveryId	Returns delivery service ID.
getDeliveryName	Returns name for delivery service.
getExtraServices	Returns additional services for shipment.
getId	Returns shipment ID.
getPrice	Returns delivery cost with discounts and extra charges.
getRegistryType	Returns register type for an object.
getShipmentCode	Returns shipment ID.
getShipmentItemCollection	Returns shipment contents.
getShippedDate	Returns partial shipment date.
getShippedUserId	Returns user ID, who shipped a partial shipment.
getStoreId	Returns self-pickup warehouse.
getUfId	Returns user field IDs.
getUnshipReason	Returns reason for cancelling shipping of partial shipment.
getVatRate	Returns VAT rate for a delivery.
getVatSum	Returns VAT amount for a delivery.
getWeight	Returns shipment weight.
isAllowDelivery	Checks if shipment delivery is allowed.
isCanceled	Checks if shipment is cancelled.
isCustomPrice	Checks for custom delivery price.
isEmpty	Checks if shipment is empty.
isExistBasketItem	Checks if this product is included into shipment.
isMarked	Checks if shipment is marked with information about errors.
isReserved	Checks if products in the shipment are reserved.
isShipped	Checks if shipment was shipped.
isSystem	Checks if shipment is a system shipment.
loadForOrder	Returns array with order shipments.
setBasePriceDelivery	Sets the cost of shipment without discounts and extra charges.
setDeliveryService	Sets delivery service for a shipment.
setExtraServices	Sets additional services for a shipment.
setOrderId	Sets an order ID.
setStoreId	Sets a self-pickup warehouse.
verify	Verifies a shipment.

Methods for parent class Bitrix\Sale\Internals\CollectableEntity

Method	Description	Available from version
createClone	Clones this item.
delete	Deletes an item.
doFinalAction	Executes finalizing actions.
getCollection	Returns collection with associated item.
getInternalIndex	Returns internal index for a collection item.
isClone	Checks if this item is a clone.
setCollection	Associates collection to an item.

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

Method	Description	Available from version
doFinalAction	Abstract method, designed to implement "final" calculation logic.
getAvailableFields	Returns array of fields to be set via methods `setField()` and `setFields()`.
getAvailableFieldsMap	Returns array of fields to be set via the methods `setField()` and `setFields()`. getAvailableFields values are used as array keys.
getField	Returns value for `$name` field.
getFieldValues	Returns array of fields with values.
getId	Returns entity ID.
initField	Initializes field by a value. Object is not considered as updated.
initFields	Initializes fields by values. Object is not considered as updated.
isChanged	Checks, if entity was updated. If yes, returns `true`, otherwise returns `false`.
isMathActionOnly	Checks, if current data is used for calculations (provider data is not requested). If yes, returns `true`, otherwise returns `false`.
setField	Sets values for the field `$name`.
setFields	Initializes fields by values. Object is not considered as updated.
setMathActionOnly	Disables requests to provider when during calculations.
verify	Checks, if object is correct. Returns object `\Bitrix\Sale\Result`.