Skip to main content

ShippingStatus

The carrier tracking state of a parcel.

enum ShippingStatus {
delivered
exception
failed
in_transit
info_received
out_for_delivery
}

Values​

ShippingStatus.delivered​

The parcel has been delivered.

ShippingStatus.exception​

A tracking exception occurred (for example a failed delivery attempt or a customs hold).

ShippingStatus.failed​

Delivery failed.

ShippingStatus.in_transit​

The parcel is travelling through the carrier network.

ShippingStatus.info_received​

The carrier has received the shipment information (the waybill has been generated, or the tracking has been set for an external carrier); the parcel has not been picked up yet.

ShippingStatus.out_for_delivery​

The parcel is out for delivery to the recipient.

Member Of​

BaseShipping interface ● RepaymentShipping object ● Shipping object ● ShippingEvent object ● ShippingStatusComparisonInput input