Документация для разработчиков

Shipment

\Bitrix\Sale\Shipment - класс отгрузок. Класс реализует интерфейсы \Bitrix\Sale\IBusinessValueProvider и \IEntityMarker.


Цепочка наследования

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

Методы класса

МетодОписание С версии
allowDelivery Разрешает доставку отгрузки. 15.5.0
calculateDelivery Рассчитывает стоимость доставки 15.5.0
create Создает объект отгрузки и привязывает к нему коллекцию. 15.5.0
delete Удаляет отгрузку из заказа (удалить можно только неотгруженную оплату). 15.5.0
disallowDelivery Отменяет разрешение доставки отгрузки. 15.5.0
getAllowDeliveryDate Возвращает дату разрешения доставки. 15.5.0
getAllowDeliveryUserId Возвращает ID пользователя, разрешившего доставку. 15.5.0
getBasketItemQuantity Возвращает количество товара в отгрузке. 15.5.0
getCompanyId Возвращает ID компании, привязанной к отгрузке. 15.5.0
getCurrency Возвращает валюту отгрузки. 15.5.0
getDelivery Возвращает объект службы доставки. 15.5.0
getDeliveryId Возвращает ID службы доставки. 15.5.0
getDeliveryName Возвращает название службы доставки. 15.5.0
getExtraServices Возвращает дополнительные сервисы для отгрузки. 15.5.0
getId Возвращает ID отгрузки. 15.5.0
getPrice Возвращает стоимость доставки с учетом скидок и наценок. 15.5.0
getRegistryType Возвращает тип реестра, к которому относится объект. 18.0.0
getShipmentCode Возвращает код отгрузки. 15.5.0
getShipmentItemCollection Возвращает состав отгрузки. 15.5.0
getShippedDate Возвращает дату отгрузки частичной отгрузки. 15.5.0
getShippedUserId Возвращает Id пользователя, который отгрузил частичную отгрузку. 15.5.0
getStoreId Возвращает склад самовывоза. 15.5.0
getUfId Возвращает ID пользовательских полей. 18.0.0
getUnshipReason Возвращает причину отмены отгрузки частичной отгрузки. 15.5.0
getVatRate Возвращает ставку НДС для доставки. 17.5.0
getVatSum Возвращает размер НДС для доставки. 17.5.0
getWeight Возвращает вес отгрузки. 15.5.0
isAllowDelivery Проверяет, разрешена ли доставка отгрузки. 15.5.0
isCanceled Проверяет, является ли отгрузка отмененной. 15.5.0
isCustomPrice Проверяет, является ли стоимость доставки кастомной. 15.5.0
isEmpty Проверяет, пустая ли отгрузка. 15.5.12
isExistBasketItem Проверяет, есть ли данный товар в отгрузке. 16.0.0
isMarked Проверяет, имеет ли отгрузка маркировку об ошибках. 15.5.0
isReserved Проверяет, зарезервированы ли товары, входящие в отгрузку. 15.5.0
isShipped Проверяет, является ли отгрузка отгруженной. 15.5.0
isSystem Проверяет, является ли отгрузка системной. 15.5.0
loadForOrder Возвращает массив отгрузок для заказа. 15.5.0
setBasePriceDelivery Устанавливает стоимость отгрузки без учет скидок и наценок. 17.8.11
setDeliveryService Устанавливает службу доставки для отгрузки. 15.5.0
setExtraServices Устанавливает дополнительные сервисы для отгрузки. 15.5.0
setOrderId Устанавливает ID заказа. 15.5.0
setStoreId Устанавливает склад самовывоза. 15.5.0
verify Проверяет отгрузку на корректность. 16.0.0

Методы родительского класса \Bitrix\Sale\Internals\CollectableEntity

МетодОписание С версии
createCloneКлонирует данный элемент. 17.5.0
deleteУдаляет элемент. 15.5.1
doFinalActionВыполняет финальные действия. 15.5.1
getCollectionВозвращает коллекцию, к которой привязан элемент. 15.5.1
getInternalIndexВозвращает внутренний индекс элемента в коллекции. 15.5.1
isCloneПроверяет, является ли данный элемент клоном. 16.0.26
setCollectionПривязывает коллекцию к элементу. 15.5.1

Методы родительского класса \Bitrix\Sale\Internals\Entity

МетодОписание С версии
doFinalActionАбстрактный метод, предназначенный для реализации логики "конечных" расчетов. 15.5.0
getAvailableFieldsВозвращает массив полей, которые могут быть установлены через методы setField() и setFields(). 15.5.0
getAvailableFieldsMapВозвращает массив полей, которые могут быть установлены через методы setField() и setFields(). В качестве ключей массива выступают значения getAvailableFields. 17.5.0
getFieldВозвращает значение поля $name. 18.0.3
getFieldValuesВозвращает массив полей со значениями. 15.5.0
getIdВозвращает идентификатор сущности. 15.5.0
initFieldИнициализирует поле значением. При этом объект не считается измененным. 15.5.0
initFieldsИнициализирует поля значениями. При этом объект не считается измененным. 15.5.0
isChangedПроверяет, была ли изменена сущность. Если да, то возвращает true, иначе false. 15.5.2
isMathActionOnlyПроверяет, идет ли расчет на текущих данных (данные из провайдера не запрашиваются). Если да, то возвращает true, иначе false. 15.5.0
setFieldУстанавливает значение поля $name. 15.5.0
setFieldsИнициализирует поля значениями. При этом объект не считается измененным. 15.5.0
setMathActionOnlyОтключает запросы к провайдеру при выполнении расчетов. 15.5.0
verifyПроверяет, корректен ли объект. Возвращает объект \Bitrix\Sale\Result. 16.0.0


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх