eBay Trading APIVersion 1119

ShippingPackageInfoType

Type defining the ShippingPackageInfoType container, which is returned in order management calls. The ShippingPackageInfoType container provides information on delivery times and tracking information for a shipping package.

Type that uses ShippingPackageInfoType:

Calls that use ShippingPackageInfoType:

Fields



ActualDeliveryTime ( dateTime ) [0..1]
This timestamp indicates when the order was actually delivered to the buyer. This field is only returned after the order has been delivered to the buyer.

Note: This field does not appear in Merchant Data API's OrderReport or SoldReport responses, because once shipment tracking information is provided to the buyer (or marked as shipped), the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport or SoldReport responses.
See the Field Index to learn which calls use ActualDeliveryTime.

EstimatedDeliveryTimeMax ( dateTime ) [0..1]
The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMax value indicates the latest date and time that the buyer can expect to receive the order.

The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields.
See the Field Index to learn which calls use EstimatedDeliveryTimeMax.

EstimatedDeliveryTimeMin ( dateTime ) [0..1]
The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMin value indicates the earliest date and time that the buyer can expect to receive the order.

The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields.
See the Field Index to learn which calls use EstimatedDeliveryTimeMin.

HandleByTime ( dateTime ) [0..1]
This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window. This date/time is calculated by adding the handling time (in days) to the purchase time.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
See the Field Index to learn which calls use HandleByTime.

MaxNativeEstimatedDeliveryTime ( dateTime ) [0..1]
The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MaxNativeEstimatedDeliveryTime value indicates the latest date and time that the buyer can expect to receive the order.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
See the Field Index to learn which calls use MaxNativeEstimatedDeliveryTime.

MinNativeEstimatedDeliveryTime ( dateTime ) [0..1]
The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MinNativeEstimatedDeliveryTime value indicates the earliest date and time that the buyer can expect to receive the order.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
See the Field Index to learn which calls use MinNativeEstimatedDeliveryTime.

ScheduledDeliveryTimeMax ( dateTime ) [0..1]
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMax value indicates the latest time that the buyer can expect to receive the order.

The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead.

Note: This field does not appear in Merchant Data API's OrderReport or SoldReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport or SoldReport responses.
See the Field Index to learn which calls use ScheduledDeliveryTimeMax.

ScheduledDeliveryTimeMin ( dateTime ) [0..1]
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMin value indicates the earliest time that the buyer can expect to receive the order.

The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead.

Note: This field does not appear in Merchant Data API's OrderReport or SoldReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport or SoldReport responses.
See the Field Index to learn which calls use ScheduledDeliveryTimeMin.

ShippingTrackingEvent ( token ) [0..1]
This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
See the Field Index to learn which calls use ShippingTrackingEvent.

StoreID ( string ) [0..1]
The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
See the Field Index to learn which calls use StoreID.