eBay Post-Order APIVersion 2.7.2
 

ShipmentTrackingType

This type is used by the shipmentTracking and allShipmentTrackings containers, which provide detailed information on the whereabouts of a shipped item, including the tracking number, origin and destination addresses, shipping status, estimated and actual shipping and delivery dates, and more.

Type that uses ShipmentTrackingType:

Calls that use ShipmentTrackingType:

Fields



active ( boolean ) [0..?]
This boolean value indicates whether or not a return request is still in an active state.
See the Field Index to learn which calls use active.

actualDeliveryDate ( DateTime ) [0..?]
The timestamp in this container indicates the date/time when the shipment arrived at its destination address. This field will not be returned until the deliveryStatus value is returned as DELIVERED.
See the Field Index to learn which calls use actualDeliveryDate.

actualShipDate ( DateTime ) [0..?]
The timestamp in this container indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been shipped or marked as shipped.
See the Field Index to learn which calls use actualShipDate.

carrierEnum ( string ) [0..?]
This value indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list.
See the Field Index to learn which calls use carrierEnum.

carrierId ( integer ) [0..?]
This integer value is the numeric identifier of the shipping carrier. This field is returned if available.
See the Field Index to learn which calls use carrierId.

carrierName ( string ) [0..?]
This field shows the name of the shipping carrier. This field is returned if available.
See the Field Index to learn which calls use carrierName.

carrierUsed ( string ) [0..?]
This string value indicates the shipping carrier used to ship the item. This field is returned if available.
See the Field Index to learn which calls use carrierUsed.

deliveryDate ( DateTime ) [0..?]
THIS FIELD IS DEPRECATED. SEE actualDeliveryDate FIELD INSTEAD.
See the Field Index to learn which calls use deliveryDate.

deliveryStatus ( TrackingStatusEnum ) [0..?]
This enumeration value indicates the tracking status of the item. This value may get returned as UNKNOWN if shipment tracking has not been provided.
See the Field Index to learn which calls use deliveryStatus.

destinationAddress ( ReturnAddressType ) [0..?]
This container provides the full address of the item's shipping destination.
See the Field Index to learn which calls use destinationAddress.

errorCode ( string ) [0..?]
This field is only returned if the user encountered an error when trying to provide shipment tracking information.
See the Field Index to learn which calls use errorCode.

labelAvailableUntilDate ( string ) [0..?]
The timestamp in this container indicates when the shipping label will expire and will no longer be valid to print and use.
See the Field Index to learn which calls use labelAvailableUntilDate.

labelDate ( DateTime ) [0..?]
The timestamp in this container indicates when the shipping label was created. This container is returned if a shipping label exists for the order line item.
See the Field Index to learn which calls use labelDate.

labelId ( string ) [0..?]
This string value is the unique eBay-assigned ID of the shipping label. This field is returned if a shipping label exists for the order line item.
See the Field Index to learn which calls use labelId.

labelPrintExpired ( boolean ) [0..?]
This boolean field will be returned as true if the shipping label has expired and is no longer valid to print and use for shipping.
See the Field Index to learn which calls use labelPrintExpired.

labelVoidExpired ( boolean ) [0..?]
This boolean field will be returned as true if the initiator of the shipping label no longer has the ability to void the shipping label.
See the Field Index to learn which calls use labelVoidExpired.

markAsReceived ( boolean ) [0..?]
This boolean field will be returned as true if the item has been mark as received by the recipient.
See the Field Index to learn which calls use markAsReceived.

maxDeliveryEstimate ( DateTime ) [0..?]
The timestamp in this container indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
See the Field Index to learn which calls use maxDeliveryEstimate.

minDeliveryEstimate ( DateTime ) [0..?]
The timestamp in this container indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
See the Field Index to learn which calls use minDeliveryEstimate.

originAddress ( ReturnAddressType ) [0..?]
This container provides the full address of the item's origin address.
See the Field Index to learn which calls use originAddress.

shipDate ( DateTime ) [0..?]
THIS FIELD IS DEPRECATED. SEE actualShipDate FIELD INSTEAD.
See the Field Index to learn which calls use shipDate.

shipmentId ( string ) [0..?]
This string value is the unique eBay-assigned ID of the shipment. This field is returned if available.
See the Field Index to learn which calls use shipmentId.

shippedBy ( ReturnUserRoleEnum ) [0..?]
This enumeration value indicates the party shipping the item, such as buyer or seller.
See the Field Index to learn which calls use shippedBy.

shippingMethod ( ShippingMethodEnum ) [0..?]
This enumeration value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.
See the Field Index to learn which calls use shippingMethod.

trackingNumber ( string ) [0..?]
This value is the tracking number of the shipment. This field is returned if shipment tracking has been uploaded.
See the Field Index to learn which calls use trackingNumber.