complexType "ns:ShipmentType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:ShipmentType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 27 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 27 elements, elem. wildcard
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:Shipment

Known Usage Locations

As direct type of elements (1):

ns:Shipment

Annotation

Type defining the Shipment container, which is used by the seller in CompleteSale to provide shipping information.

XML Source (w/o annotations (28); see within schema source)

<xs:complexType name="ShipmentType">

<xs:sequence>

<xs:element minOccurs="0" name="EstimatedDeliveryDate" type="xs:dateTime"/>

<xs:element minOccurs="0" name="InsuredValue" type="ns:AmountType"/>

<xs:element minOccurs="0" name="PackageDepth" type="ns:MeasureType"/>

<xs:element minOccurs="0" name="PackageLength" type="ns:MeasureType"/>

<xs:element minOccurs="0" name="PackageWidth" type="ns:MeasureType"/>

<xs:element minOccurs="0" name="PayPalShipmentID" type="xs:string"/>

<xs:element minOccurs="0" name="ShipmentID" type="xs:long"/>

<xs:element minOccurs="0" name="PostageTotal" type="ns:AmountType"/>

<xs:element minOccurs="0" name="PrintedTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="ShipFromAddress" type="ns:AddressType"/>

<xs:element minOccurs="0" name="ShippingAddress" type="ns:AddressType"/>

<xs:element minOccurs="0" name="ShippingCarrierUsed" type="xs:string"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingFeature" type="ns:ShippingFeatureCodeType"/>

<xs:element minOccurs="0" name="ShippingPackage" type="ns:ShippingPackageCodeType"/>

<xs:element minOccurs="0" name="ShippingServiceUsed" type="xs:token"/>

<xs:element minOccurs="0" name="ShipmentTrackingNumber" type="xs:string"/>

<xs:element minOccurs="0" name="WeightMajor" type="ns:MeasureType"/>

<xs:element minOccurs="0" name="WeightMinor" type="ns:MeasureType"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="ItemTransactionID" type="ns:ItemTransactionIDType"/>

<xs:element minOccurs="0" name="DeliveryDate" type="xs:dateTime"/>

<xs:element minOccurs="0" name="DeliveryStatus" type="ns:ShipmentDeliveryStatusCodeType"/>

<xs:element minOccurs="0" name="RefundGrantedTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="RefundRequestedTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="Status" type="ns:ShipmentStatusCodeType"/>

<xs:element minOccurs="0" name="ShippedTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="Notes" type="xs:string"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="ShipmentTrackingDetails" type="ns:ShipmentTrackingDetailsType"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 28/28)

ns:DeliveryDate

Type:

xs:dateTime, predefined, simple content

Revise only

XML Representation Summary

<ns:DeliveryDate>

Content:

{ xs:dateTime }

</ns:DeliveryDate>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DeliveryDate" type="xs:dateTime"/>

ns:DeliveryStatus

Type:

ns:ShipmentDeliveryStatusCodeType, simple content

Revise only

XML Representation Summary

<ns:DeliveryStatus>

Content:

{ enumeration of xs:token }

</ns:DeliveryStatus>

Simple Content

Enumeration:

"Created"	-	Created (default).
"DroppedOff"	-	Dropped off.
"InTransit"	-	In transit.
"Delivered"	-	Delivered.
"Returned"	-	Returned.
"Canceled"	-	Cancelled.
"LabelPrinted"	-	Label printed.
"Unconfirmed"	-	Unconfirmed.
"Unknown"	-	Unknown.
"Error"	-	Error.
"CustomCode"	-	Reserved for future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DeliveryStatus" type="ns:ShipmentDeliveryStatusCodeType"/>

ns:EstimatedDeliveryDate

Type:

xs:dateTime, predefined, simple content

XML Representation Summary

<ns:EstimatedDeliveryDate>

Content:

{ xs:dateTime }

</ns:EstimatedDeliveryDate>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="EstimatedDeliveryDate" type="xs:dateTime"/>

ns:InsuredValue

Type:

ns:AmountType, simple content

Component Diagram

XML Representation Summary

<ns:InsuredValue

currencyID

("AFA" | "ALL" | "DZD" | "ADP" | "AOA" | "ARS" | "AMD" | "AWG" | "AZM" | "BSD" | "BHD" | "BDT" | "BBD" | "BYR" | "BZD" | "BMD" | "BTN" | "INR" | "BOV" | "BOB" | "BAM" | "BWP" | "BRL" | "BND" | "BGL" | "BGN" | "BIF" | "KHR" | "CAD" | "CVE" | "KYD" | "XAF" | "CLF" | "CLP" | "CNY" | "COP" | "KMF" | "CDF" | "CRC" | "HRK" | "CUP" | "CYP" | "CZK" | "DKK" | "DJF" | "DOP" | "TPE" | "ECV" | "ECS" | "EGP" | "SVC" | "ERN" | "EEK" | "ETB" | "FKP" | "FJD" | "GMD" | "GEL" | "GHC" | "GIP" | "GTQ" | "GNF" | "GWP" | "GYD" | "HTG" | "HNL" | "HKD" | "HUF" | "ISK" | "IDR" | "IRR" | "IQD" | "ILS" | "JMD" | "JPY" | "JOD" | "KZT" | "KES" | "AUD" | "KPW" | "KRW" | "KWD" | "KGS" | "LAK" | "LVL" | "LBP" | "LSL" | "LRD" | "LYD" | "CHF" | "LTL" | "MOP" | "MKD" | "MGF" | "MWK" | "MYR" | "MVR" | "MTL" | "EUR" | "MRO" | "MUR" | "MXN" | "MXV" | "MDL" | "MNT" | "XCD" | "MZM" | "MMK" | "ZAR" | "NAD" | "NPR" | "ANG" | "XPF" | "NZD" | "NIO" | "NGN" | "NOK" | "OMR" | "PKR" | "PAB" | "PGK" | "PYG" | "PEN" | "PHP" | "PLN" | "USD" | "QAR" | "ROL" | "RUB" | "RUR" | "RWF" | "SHP" | "WST" | "STD" | "SAR" | "SCR" | "SLL" | "SGD" | "SKK" | "SIT" | "SBD" | "SOS" | "LKR" | "SDD" | "SRG" | "SZL" | "SEK" | "SYP" | "TWD" | "TJS" | "TZS" | "THB" | "XOF" | "TOP" | "TTD" | "TND" | "TRL" | "TMM" | "UGX" | "UAH" | "AED" | "GBP" | "USS" | "USN" | "UYU" | "UZS" | "VUV" | "VEB" | "VND" | "MAD" | "YER" | "YUM" | "ZMK" | "ZWD" | "ATS" | "CustomCode")

Content:

{ xs:double }

</ns:InsuredValue>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="InsuredValue" type="ns:AmountType"/>

ns:ItemTransactionID

Type:

ns:ItemTransactionIDType, complex content

Component Diagram

XML Representation Summary

<ns:ItemTransactionID>

Content:

ns:ItemID?, ns:TransactionID?, ns:SKU?, ns:OrderLineItemID?, {any}*

</ns:ItemTransactionID>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="ItemTransactionID" type="ns:ItemTransactionIDType"/>

ns:Notes

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:Notes>

Content:

{ xs:string }

</ns:Notes>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Notes" type="xs:string"/>

ns:PackageDepth

Type:

ns:MeasureType, simple content

Depth dimension of the package needed to ship the item after it is sold.
For calculated shipping only.

Component Diagram

XML Representation Summary

<ns:PackageDepth

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:PackageDepth>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PackageDepth" type="ns:MeasureType"/>

ns:PackageLength

Type:

ns:MeasureType, simple content

Length dimension of the package needed to ship the item after it is sold.
For calculated shipping only.

Component Diagram

XML Representation Summary

<ns:PackageLength

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:PackageLength>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PackageLength" type="ns:MeasureType"/>

ns:PackageWidth

Type:

ns:MeasureType, simple content

Width dimension of the package needed to ship the item after it is sold.
For calculated shipping only.

Component Diagram

XML Representation Summary

<ns:PackageWidth

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:PackageWidth>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PackageWidth" type="ns:MeasureType"/>

ns:PayPalShipmentID

Type:

xs:string, predefined, simple content

XML Representation Summary

<ns:PayPalShipmentID>

Content:

{ xs:string }

</ns:PayPalShipmentID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PayPalShipmentID" type="xs:string"/>

ns:PostageTotal

Type:

ns:AmountType, simple content

Component Diagram

XML Representation Summary

<ns:PostageTotal

currencyID

Content:

{ xs:double }

</ns:PostageTotal>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PostageTotal" type="ns:AmountType"/>

ns:PrintedTime

Type:

xs:dateTime, predefined, simple content

XML Representation Summary

<ns:PrintedTime>

Content:

{ xs:dateTime }

</ns:PrintedTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PrintedTime" type="xs:dateTime"/>

ns:RefundGrantedTime

Type:

xs:dateTime, predefined, simple content

Revise only

XML Representation Summary

<ns:RefundGrantedTime>

Content:

{ xs:dateTime }

</ns:RefundGrantedTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="RefundGrantedTime" type="xs:dateTime"/>

ns:RefundRequestedTime

Type:

xs:dateTime, predefined, simple content

Revise only

XML Representation Summary

<ns:RefundRequestedTime>

Content:

{ xs:dateTime }

</ns:RefundRequestedTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="RefundRequestedTime" type="xs:dateTime"/>

ns:ShipFromAddress

Type:

ns:AddressType, complex content

The address from which the item is being shipped.

Component Diagram

XML Representation Summary

<ns:ShipFromAddress>

Content:

</ns:ShipFromAddress>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShipFromAddress" type="ns:AddressType"/>

ns:ShipmentID

Type:

xs:long, predefined, simple content

XML Representation Summary

<ns:ShipmentID>

Content:

{ xs:long }

</ns:ShipmentID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShipmentID" type="xs:long"/>

ns:ShipmentTrackingDetails

Type:

ns:ShipmentTrackingDetailsType, complex content

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.

Component Diagram

XML Representation Summary

<ns:ShipmentTrackingDetails>

Content:

ns:ShippingCarrierUsed?, ns:ShipmentTrackingNumber?, ns:ShipmentLineItem?, {any}*

</ns:ShipmentTrackingDetails>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="ShipmentTrackingDetails" type="ns:ShipmentTrackingDetailsType"/>

ns:ShipmentTrackingNumber

Type:

xs:string, predefined, simple content

This field is deprecated.

XML Representation Summary

<ns:ShipmentTrackingNumber>

Content:

{ xs:string }

</ns:ShipmentTrackingNumber>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShipmentTrackingNumber" type="xs:string"/>

ns:ShippedTime

Type:

xs:dateTime, predefined, simple content

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.

XML Representation Summary

<ns:ShippedTime>

Content:

{ xs:dateTime }

</ns:ShippedTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShippedTime" type="xs:dateTime"/>

ns:ShippingAddress

Type:

ns:AddressType, complex content

The address to which the item is to be shipped.

Component Diagram

XML Representation Summary

<ns:ShippingAddress>

Content:

</ns:ShippingAddress>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShippingAddress" type="ns:AddressType"/>

ns:ShippingCarrierUsed

Type:

xs:string, predefined, simple content

This field is deprecated.

XML Representation Summary

<ns:ShippingCarrierUsed>

Content:

{ xs:string }

</ns:ShippingCarrierUsed>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShippingCarrierUsed" type="xs:string"/>

ns:ShippingFeature

Type:

ns:ShippingFeatureCodeType, simple content

XML Representation Summary

<ns:ShippingFeature>

Content:

{ enumeration of xs:token }

</ns:ShippingFeature>

Simple Content

Enumeration:

"DeliveryConfirmation"	-	Confirmation requested.
"SignatureConfirmation"	-	Signature requested upon receipt.
"StealthPostage"	-	Stealth postage.
"SaturdayDelivery"	-	Saturday delivery.
"Other"	-	Other.
"NotDefined"	-	Not defined.
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingFeature" type="ns:ShippingFeatureCodeType"/>

ns:ShippingPackage

Type:

ns:ShippingPackageCodeType, simple content

The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.

XML Representation Summary

<ns:ShippingPackage>

Content:

{ enumeration of xs:token }

</ns:ShippingPackage>

Simple Content

Enumeration:

see details at ns:ShippingPackageCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShippingPackage" type="ns:ShippingPackageCodeType"/>

ns:ShippingServiceUsed

Type:

xs:token, predefined, simple content

The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.

XML Representation Summary

<ns:ShippingServiceUsed>

Content:

{ xs:token }

</ns:ShippingServiceUsed>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShippingServiceUsed" type="xs:token"/>

ns:Status

Type:

ns:ShipmentStatusCodeType, simple content

Status, for revise only

XML Representation Summary

<ns:Status>

Content:

{ enumeration of xs:token }

</ns:Status>

Simple Content

Enumeration:

"Active", "Canceled", "CustomCode"

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Status" type="ns:ShipmentStatusCodeType"/>

ns:WeightMajor

Type:

ns:MeasureType, simple content

The 'unit' attribute can have a value of lbs.

Component Diagram

XML Representation Summary

<ns:WeightMajor

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:WeightMajor>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="WeightMajor" type="ns:MeasureType"/>

ns:WeightMinor

Type:

ns:MeasureType, simple content

The 'unit' attribute is optional and assumed to be the minor compared to the value of 'unit' in WeightMajor.

Component Diagram

XML Representation Summary

<ns:WeightMinor

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:WeightMinor>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="WeightMinor" type="ns:MeasureType"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.