eBay Trading APIVersion 1085

ShipmentTrackingDetailsType

This type details the shipping carrier and shipment tracking number associated with a package shipment. It also contains information about the line items shipped through the Global Shipping program.

Types that use ShipmentTrackingDetailsType:

Calls that use ShipmentTrackingDetailsType:

Fields

ShipmentLineItem ( ShipmentLineItemType ) [0..1]
Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of ShippingCarrierUsed is PBI.
See the Field Index to learn which calls use ShipmentLineItem.

ShipmentTrackingNumber ( string ) [0..1]
The tracking number assigned by the shipping carrier to the item shipment. This field and the ShippingCarrierUsed field are mutually dependent. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber.

The format of the tracking number must be consistent with the format used by the specified shipping carrier (ShippingCarrierUsed). Typically, you should avoid spaces and hyphens. Returned only if set.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real tracking number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
See the Field Index to learn which calls use ShipmentTrackingNumber.

ShippingCarrierUsed ( string ) [0..1]
The name of the shipping carrier used to ship the item. This field and the ShipmentTrackingNumber field are mutually dependent. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed.

When the site ID is Austria, Poland, or UK, ShippingCarrierUsed can be any value, because it is not checked by eBay. For all other sites, only the following characters are allowed: letters (a-z, A-Z), numbers (0-9), space, and dash (-). The site ID is specified in the CompleteSale request header.

Note: Commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierDetails.ShippingCarrier field. However, as of release 961, ShippingCarrierCodeType contains the most current list of shipping carriers and the countries served by each carrier. The GeteBayDetails call is being updated to provide the same information more conveniently in an upcoming release. For the CompleteSale call:
  • This field is not case sensitive in the CompleteSale request.
  • When using UPS Mail Innovations, supply the value UPS-MI. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking status.
  • When using FedEx SmartPost, supply the value FedEx. Buyers will subsequently be sent to the FedEx web site for tracking status.
For the Get calls: When using the Global Shipping Program, this field returns a value of PBI.

Returned only if set.
See the Field Index to learn which calls use ShippingCarrierUsed.