eBay Trading APIVersion 1085

ShipmentType

Type defining the Shipment container, which is used by the seller in CompleteSale to provide shipping information. The Shipment container is also returned in the GetSellingManagerSaleRecord response.

Types that use ShipmentType:

Calls that use ShipmentType:

Fields



DeliveryDate ( dateTime ) [0..1]
Not used by any call.

Revise only
See the Field Index to learn which calls use DeliveryDate.

DeliveryStatus ( ShipmentDeliveryStatusCodeType ) [0..1]
Not used by any call.

Revise only
See the Field Index to learn which calls use DeliveryStatus.

EstimatedDeliveryDate ( dateTime ) [0..1]
Not used by any call.

See the Field Index to learn which calls use EstimatedDeliveryDate.

InsuredValue ( AmountType (double) ) [0..1]
Not used by any call.

See the Field Index to learn which calls use InsuredValue.

ItemTransactionID ( ItemTransactionIDType ) [0..*]
Not used by any call.

See the Field Index to learn which calls use ItemTransactionID.

Notes ( string ) [0..1]
Not used by any call.

Note: This field is only applicable for Half.com listings, and since API support for Half.com listings is being deprecated, this field is no longer applicable. This string field allows a seller to provide notes to the buyer regarding shipment of a Half.com item. Only alphanumeric characters can be used in this field. This is an optional field that is only applicable to Half.com items.
See the Field Index to learn which calls use Notes.

PackageDepth ( MeasureType (decimal) ) [0..1]
Not used by any call.

Depth dimension of the package needed to ship the item after it is sold.
For calculated shipping only.
See the Field Index to learn which calls use PackageDepth.

PackageLength ( MeasureType (decimal) ) [0..1]
Not used by any call.

Length dimension of the package needed to ship the item after it is sold.
For calculated shipping only.
See the Field Index to learn which calls use PackageLength.

PackageWidth ( MeasureType (decimal) ) [0..1]
Not used by any call.

Width dimension of the package needed to ship the item after it is sold.
For calculated shipping only.
See the Field Index to learn which calls use PackageWidth.

PayPalShipmentID ( string ) [0..1]
Not used by any call.

See the Field Index to learn which calls use PayPalShipmentID.

PostageTotal ( AmountType (double) ) [0..1]
Not used by any call.

See the Field Index to learn which calls use PostageTotal.

PrintedTime ( dateTime ) [0..1]
Not used by any call.

See the Field Index to learn which calls use PrintedTime.

RefundGrantedTime ( dateTime ) [0..1]
Not used by any call.

Revise only
See the Field Index to learn which calls use RefundGrantedTime.

RefundRequestedTime ( dateTime ) [0..1]
Not used by any call.

Revise only
See the Field Index to learn which calls use RefundRequestedTime.

ShipFromAddress ( AddressType ) [0..1]
Not used by any call.

The address from which the item is being shipped.
See the Field Index to learn which calls use ShipFromAddress.

ShipmentID ( long ) [0..1]
Not used by any call.

See the Field Index to learn which calls use ShipmentID.

ShipmentLineItem ( ShipmentLineItemType ) [0..1]
Not used by any call.

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.

ShipmentTrackingDetails ( ShipmentTrackingDetailsType ) [0..*]
Container consisting of the tracking number and shipping carrier associated with the shipment of one item (package).

Because an order can have multiple line items and/or packages, there can be multiple ShipmentTrackingDetails containers under the Shipment container.
See the Field Index to learn which calls use ShipmentTrackingDetails.

ShipmentTrackingNumber ( string ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use ShipmentTrackingNumber.

ShippedTime ( dateTime ) [0..1]
The date and time that the seller handed off the package(s) to the shipping carrier. If this field is not included in the request, the timestamp of the call execution is used as the shipped time. Note that sellers have the ability to set this value up to 3 calendar days in the future.
See the Field Index to learn which calls use ShippedTime.

ShippingAddress ( AddressType ) [0..1]
Not used by any call.

The address to which the item is to be shipped.
See the Field Index to learn which calls use ShippingAddress.

ShippingCarrierUsed ( string ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use ShippingCarrierUsed.

ShippingFeature ( ShippingFeatureCodeType ) [0..*]
Not used by any call.

See the Field Index to learn which calls use ShippingFeature.

ShippingPackage ( ShippingPackageCodeType ) [0..1]
Not used by any call.

The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.
See the Field Index to learn which calls use ShippingPackage.

ShippingServiceUsed ( token ) [0..1]
Not used by any call.

The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.
See the Field Index to learn which calls use ShippingServiceUsed.

Status ( ShipmentStatusCodeType ) [0..1]
Not used by any call.

Status, for revise only
See the Field Index to learn which calls use Status.

WeightMajor ( MeasureType (decimal) ) [0..1]
Not used by any call.

The 'unit' attribute can have a value of lbs.
See the Field Index to learn which calls use WeightMajor.

WeightMinor ( MeasureType (decimal) ) [0..1]
Not used by any call.

The 'unit' attribute is optional and assumed to be the minor compared to the value of 'unit' in WeightMajor.
See the Field Index to learn which calls use WeightMinor.