sale.shipment.getFields

sale.shipment.getFields()

The method returns shipment fields.

Returned fields:

Field	Description
id	Shipment ID.
orderId	Order ID.
statusId	Shipment status.
basePriceDelivery	Base delivery price.
priceDelivery	Delivery cost.
customPriceDelivery	Flag, specifies custom price.
currency	Currency.
discountPrice	Final discount price/extra charge for delivery.
allowDelivery	Flag, allows delivery: Y/N.
dateAllowDelivery	Date when delivery is allowed.
empAllowDeliveryId	User ID, who permitted delivery.
deducted	Flag, set for delivery: Y/N.
dateDeducted	Date of shipment.
empDeductedId	User ID, who dispatched shipment.
reasonUndoDeducted	Reason for shipment cancellation.
deliveryId	Delivery service ID.
deliveryDocNum	Number of shipping document.
deliveryDocDate	Date of shipping document.
trackingNumber	Track number.
trackingStatus	Tracking status.
trackingDescription	Tracking status description.
trackingLastCheck	Date of last tracking status check.
xmlId	External ID.
deliveryName	Name of delivery service.
canceled	If shipment is cancelled.
dateCanceled	Date when shipment is cancelled.
empCanceledId	User ID, who cancelled shipment.
marked	If shipment is marked.
dateMarked	Date when marked.
empMarkedId	User ID, who marked the shipment.
reasonMarked	Reason for marking.
system	Flag, specifies if the shipment is systemic or not.
responsibleId	User ID, who is responsible for shipment.
empResponsibleId	User ID, who assigned a responsible user.
dateResponsibleId	Date when a responsible user is assigned.
comments	Comment.
companyId	Company ID that performs shipment.
updated1c	Whether shipment is updated via 1С
id1c	Shipment ID in 1С.
version1c	Shipping document version in 1С.
externalDelivery	Flag Y/N: is delivery performed from external system or no.

Parameters

No parameters.

Examples

BX24.callMethod(
    'sale.shipment.getFields', 
    {}, 
    function(result)
    {
        if(result.error())
            console.error(result.error().ex);
        else
            console.log(result.data());
});