Documentation

sale.shipment.getFields

sale.shipment.getFields()

The method returns shipment fields.

Returned fields:

Field Description
idShipment ID.
orderIdOrder ID.
statusIdShipment status.
basePriceDeliveryBase delivery price.
priceDeliveryDelivery cost.
customPriceDeliveryFlag, specifies custom price.
currencyCurrency.
discountPriceFinal discount price/extra charge for delivery.
allowDeliveryFlag, allows delivery: Y/N.
dateAllowDeliveryDate when delivery is allowed.
empAllowDeliveryIdUser ID, who permitted delivery.
deductedFlag, set for delivery: Y/N.
dateDeductedDate of shipment.
empDeductedIdUser ID, who dispatched shipment.
reasonUndoDeductedReason for shipment cancellation.
deliveryIdDelivery service ID.
deliveryDocNumNumber of shipping document.
deliveryDocDateDate of shipping document.
trackingNumberTrack number.
trackingStatusTracking status.
trackingDescriptionTracking status description.
trackingLastCheckDate of last tracking status check.
xmlIdExternal ID.
deliveryNameName of delivery service.
canceledIf shipment is cancelled.
dateCanceledDate when shipment is cancelled.
empCanceledIdUser ID, who cancelled shipment.
markedIf shipment is marked.
dateMarkedDate when marked.
empMarkedIdUser ID, who marked the shipment.
reasonMarkedReason for marking.
systemFlag, specifies if the shipment is systemic or not.
responsibleIdUser ID, who is responsible for shipment.
empResponsibleIdUser ID, who assigned a responsible user.
dateResponsibleIdDate when a responsible user is assigned.
commentsComment.
companyIdCompany ID that performs shipment.
updated1cWhether shipment is updated via 1С
id1cShipment ID in 1С.
version1cShipping document version in 1С.
externalDeliveryFlag 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());
});


© «Bitrix24», 2001-2022
Up