# XML Schema Documentation

Printer-friendly Version
XML Instance Representation:
[ Expand All | Collapse All ]
Schema Component Representation:
[ Expand All | Collapse All ]

## Table of Contents

- Schema Document Properties
- Global Declarations
  - Element: PickupCancelRequest
  - Element: PickupCancelResponse
  - Element: PickupCreationRequest
  - Element: PickupCreationResponse
  - Element: PickupPendingStatusRequest
  - Element: PickupPendingStatusResponse
  - Element: PickupRateRequest
  - Element: PickupRateResponse
- Global Definitions
  - Complex Type: AccountType
  - Complex Type: AddressType
  - Complex Type: CSRType
  - Complex Type: ChargeCardAddressType
  - Complex Type: ChargeCardType
  - Complex Type: ChargeDetailType
  - Complex Type: FutureServiceDateType
  - Complex Type: NotificationType
  - Complex Type: PendingStatusType
  - Complex Type: PhoneType
  - Complex Type: PickupAddressType
  - Complex Type: PickupDateInfoType
  - Complex Type: PickupPieceType
  - Complex Type: RateResultType
  - Complex Type: ShipperType
  - Complex Type: SimpleAddressType
  - Complex Type: StatusCodeDescriptionType
  - Complex Type: StreetAddressArtifactType
  - Complex Type: TodayType
  - Complex Type: TrackingDataType
  - Complex Type: WeightType

- Legend

- Glossary

top

## Schema Document Properties

Target Namespace | http://www.ups.com/XMLSchema/XOLTWS/Pickup/v1.1
Element and Attribute Namespaces | Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations belong to this schema's target namespace. By default, local attribute declarations have no namespace.
Schema Composition | This schema imports schema(s) from the following namespace(s): http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0 (at common.xsd)

### Declared Namespaces

Prefix | Namespace
--- | ---
Default namespace | http://www.ups.com/XMLSchema/XOLTWS/Pickup/v1.1
xml | http://www.w3.org/XML/1998/namespace
ups | http://www.ups.com/XMLSchema
pkup | http://www.ups.com/XMLSchema/XOLTWS/Pickup/v1.1
common | http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0
xsd | http://www.w3.org/2001/XMLSchema

Schema Component Representation
<xsd:schema elementFormDefault="qualified" targetNamespace="http://www.ups.com/XMLSchema/XOLTWS/Pickup/v1.1">
<xsd:import namespace="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0" schemaLocation="common.xsd"/>
...
</xsd:schema>
top

## Global Declarations

### Element: PickupCancelRequest

Name | PickupCancelRequest
Type | Locally-defined complex type
Nillable | no
Abstract | no

XML Instance Representation
<pkup:PickupCancelRequest>
<common:Request> ... </common:Request> [1]
<pkup:CancelBy> xsd:string </pkup:CancelBy> [1]
<pkup:PRN> xsd:string </pkup:PRN> [0..1]
</pkup:PickupCancelRequest>
Schema Component Representation
<xsd:element name="PickupCancelRequest">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="common:Request"/>
<xsd:element name="CancelBy" type="xsd:string"/>
<xsd:element name="PRN" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

### Element: PickupCancelResponse

Name | PickupCancelResponse
Type | Locally-defined complex type
Nillable | no
Abstract | no

XML Instance Representation
<pkup:PickupCancelResponse>
<common:Response> ... </common:Response> [1]
<pkup:PickupType> xsd:string </pkup:PickupType> [1]
<pkup:GWNStatus> StatusCodeDescriptionType </pkup:GWNStatus> [0..1]
</pkup:PickupCancelResponse>
Schema Component Representation
<xsd:element name="PickupCancelResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="common:Response"/>
<xsd:element name="PickupType" type="xsd:string"/>
<xsd:element name="GWNStatus" type="StatusCodeDescriptionType" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

### Element: PickupCreationRequest

Name | PickupCreationRequest
Type | Locally-defined complex type
Nillable | no
Abstract | no

XML Instance Representation
<pkup:PickupCreationRequest>
<common:Request> ... </common:Request> [1]
<pkup:RatePickupIndicator> xsd:string </pkup:RatePickupIndicator> [1]
<pkup:Shipper> ShipperType </pkup:Shipper> [0..1]
<pkup:PickupDateInfo> PickupDateInfoType </pkup:PickupDateInfo> [1]
<pkup:PickupAddress> PickupAddressType </pkup:PickupAddress> [1]
<pkup:AlternateAddressIndicator> xsd:string </pkup:AlternateAddressIndicator> [1]
<pkup:PickupPiece> PickupPieceType </pkup:PickupPiece> [1..*]
<pkup:TotalWeight> WeightType </pkup:TotalWeight> [0..1]
<pkup:OverweightIndicator> xsd:string </pkup:OverweightIndicator> [1]
<pkup:TrackingData> TrackingDataType </pkup:TrackingData> [0..*]
<pkup:PaymentMethod> xsd:string </pkup:PaymentMethod> [1]
<pkup:SpecialInstruction> xsd:string </pkup:SpecialInstruction> [0..1]
<pkup:ReferenceNumber> xsd:string </pkup:ReferenceNumber> [0..1]
<pkup:Notification> NotificationType </pkup:Notification> [0..1]
</pkup:PickupCreationRequest>
Schema Component Representation
<xsd:element name="PickupCreationRequest">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="common:Request"/>
<xsd:element name="RatePickupIndicator" type="xsd:string" default="N"/>
<xsd:element name="Shipper" type="ShipperType" minOccurs="0"/>
<xsd:element name="PickupDateInfo" type="PickupDateInfoType"/>
<xsd:element name="PickupAddress" type="PickupAddressType"/>
<xsd:element name="AlternateAddressIndicator" type="xsd:string" default="N"/>
<xsd:element name="PickupPiece" type="PickupPieceType" maxOccurs="unbounded"/>
<xsd:element name="TotalWeight" type="WeightType" minOccurs="0"/>
<xsd:element name="OverweightIndicator" type="xsd:string" default="N"/>
<xsd:element name="TrackingData" type="TrackingDataType" maxOccurs="unbounded" minOccurs="0"/>
<xsd:element name="PaymentMethod" type="xsd:string" default="00"/>
<xsd:element name="SpecialInstruction" type="xsd:string" minOccurs="0"/>
<xsd:element name="ReferenceNumber" type="xsd:string" minOccurs="0"/>
<xsd:element name="Notification" type="NotificationType" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

### Element: PickupCreationResponse

Name | PickupCreationResponse
Type | Locally-defined complex type
Nillable | no
Abstract | no

XML Instance Representation
<pkup:PickupCreationResponse>
<common:Response> ... </common:Response> [1]
<pkup:PRN> xsd:string </pkup:PRN> [1]
<pkup:RateStatus> StatusCodeDescriptionType </pkup:RateStatus> [1]
<pkup:RateResult> RateResultType </pkup:RateResult> [0..1]
</pkup:PickupCreationResponse>
Schema Component Representation
<xsd:element name="PickupCreationResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="common:Response"/>
<xsd:element name="PRN" type="xsd:string"/>
<xsd:element name="RateStatus" type="StatusCodeDescriptionType"/>
<xsd:element name="RateResult" type="RateResultType" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

### Element: PickupPendingStatusRequest

Name | PickupPendingStatusRequest
Type | Locally-defined complex type
Nillable | no
Abstract | no

XML Instance Representation
<pkup:PickupPendingStatusRequest>
<common:Request> ... </common:Request> [1]
<pkup:PickupType> xsd:string </pkup:PickupType> [1]
<pkup:AccountNumber> xsd:string </pkup:AccountNumber> [1]
</pkup:PickupPendingStatusRequest>
Schema Component Representation
<xsd:element name="PickupPendingStatusRequest">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="common:Request"/>
<xsd:element name="PickupType" type="xsd:string"/>
<xsd:element name="AccountNumber" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

### Element: PickupPendingStatusResponse

Name | PickupPendingStatusResponse
Type | Locally-defined complex type
Nillable | no
Abstract | no

XML Instance Representation
<pkup:PickupPendingStatusResponse>
<common:Response> ... </common:Response> [1]
<pkup:PendingStatus> PendingStatusType </pkup:PendingStatus> [0..*]
</pkup:PickupPendingStatusResponse>
Schema Component Representation
<xsd:element name="PickupPendingStatusResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="common:Response"/>
<xsd:element name="PendingStatus" type="PendingStatusType" maxOccurs="unbounded" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

### Element: PickupRateRequest

Name | PickupRateRequest
Type | Locally-defined complex type
Nillable | no
Abstract | no

XML Instance Representation
<pkup:PickupRateRequest>
<common:Request> ... </common:Request> [1]
<pkup:PickupAddress> AddressType </pkup:PickupAddress> [1]
<pkup:AlternateAddressIndicator> xsd:string </pkup:AlternateAddressIndicator> [1]
<pkup:ServiceDateOption> xsd:string </pkup:ServiceDateOption> [1]
<pkup:PickupDateInfo> PickupDateInfoType </pkup:PickupDateInfo> [0..1]
</pkup:PickupRateRequest>
Schema Component Representation
<xsd:element name="PickupRateRequest">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="common:Request"/>
<xsd:element name="PickupAddress" type="AddressType"/>
<xsd:element name="AlternateAddressIndicator" type="xsd:string" default="N"/>
<xsd:element name="ServiceDateOption" type="xsd:string"/>
<xsd:element name="PickupDateInfo" type="PickupDateInfoType" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

### Element: PickupRateResponse

Name | PickupRateResponse
Type | Locally-defined complex type
Nillable | no
Abstract | no

XML Instance Representation
<pkup:PickupRateResponse>
<common:Response> ... </common:Response> [1]
<pkup:RateResult> RateResultType </pkup:RateResult> [1]
</pkup:PickupRateResponse>
Schema Component Representation
<xsd:element name="PickupRateResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="common:Response"/>
<xsd:element name="RateResult" type="RateResultType"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

## Global Definitions

### Complex Type: AccountType

Super-types: | None
Sub-types: | None

Name | AccountType
Abstract | no

XML Instance Representation
<...>
<pkup:AccountNumber> xsd:string </pkup:AccountNumber> [1]
<pkup:AccountCountryCode> xsd:string </pkup:AccountCountryCode> [1]
</...>
Schema Component Representation
<xsd:complexType name="AccountType">
<xsd:sequence>
<xsd:element name="AccountNumber" type="xsd:string"/>
<xsd:element name="AccountCountryCode" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: AddressType

Super-types: | None
Sub-types: | None

Name | AddressType
Abstract | no

XML Instance Representation
<...>
<pkup:AddressLine> xsd:string </pkup:AddressLine> [0..*]
<pkup:City> xsd:string </pkup:City> [1]
<pkup:StateProvince> xsd:string </pkup:StateProvince> [1]
<pkup:PostalCode> xsd:string </pkup:PostalCode> [1]
<pkup:CountryCode> xsd:string </pkup:CountryCode> [1]
<pkup:ResidentialIndicator> xsd:string </pkup:ResidentialIndicator> [1]
</...>
Schema Component Representation
<xsd:complexType name="AddressType">
<xsd:sequence>
<xsd:element name="AddressLine" type="xsd:string" maxOccurs="unbounded" minOccurs="0"/>
<xsd:element name="City" type="xsd:string"/>
<xsd:element name="StateProvince" type="xsd:string"/>
<xsd:element name="PostalCode" type="xsd:string"/>
<xsd:element name="CountryCode" type="xsd:string"/>
<xsd:element name="ResidentialIndicator" type="xsd:string" default="N"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: CSRType

Super-types: | None
Sub-types: | None

Name | CSRType
Abstract | no

XML Instance Representation
<...>
<pkup:ProfileId> xsd:string </pkup:ProfileId> [0..1]
<pkup:ProfileCountryCode> xsd:string </pkup:ProfileCountryCode> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="CSRType">
<xsd:sequence>
<xsd:element name="ProfileId" type="xsd:string" minOccurs="0"/>
<xsd:element name="ProfileCountryCode" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: ChargeCardAddressType

Super-types: | None
Sub-types: | None

Name | ChargeCardAddressType
Abstract | no

XML Instance Representation
<...>
<pkup:AddressLine> xsd:string </pkup:AddressLine> [0..*]
<pkup:City> xsd:string </pkup:City> [0..1]
<pkup:StateProvince> xsd:string </pkup:StateProvince> [0..1]
<pkup:PostalCode> xsd:string </pkup:PostalCode> [0..1]
<pkup:CountryCode> xsd:string </pkup:CountryCode> [1]
</...>
Schema Component Representation
<xsd:complexType name="ChargeCardAddressType">
<xsd:sequence>
<xsd:element name="AddressLine" type="xsd:string" maxOccurs="unbounded" minOccurs="0"/>
<xsd:element name="City" type="xsd:string" minOccurs="0"/>
<xsd:element name="StateProvince" type="xsd:string" minOccurs="0"/>
<xsd:element name="PostalCode" type="xsd:string" minOccurs="0"/>
<xsd:element name="CountryCode" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: ChargeCardType

Super-types: | None
Sub-types: | None

Name | ChargeCardType
Abstract | no

XML Instance Representation
<...>
<pkup:CardHolderName> xsd:string </pkup:CardHolderName> [0..1]
<pkup:CardType> xsd:string </pkup:CardType> [1]
<pkup:CardNumber> xsd:string </pkup:CardNumber> [1]
<pkup:ExpirationDate> xsd:string </pkup:ExpirationDate> [1]
<pkup:SecurityCode> xsd:string </pkup:SecurityCode> [1]
<pkup:CardAddress> ChargeCardAddressType </pkup:CardAddress> [1]
</...>
Schema Component Representation
<xsd:complexType name="ChargeCardType">
<xsd:sequence>
<xsd:element name="CardHolderName" type="xsd:string" minOccurs="0"/>
<xsd:element name="CardType" type="xsd:string"/>
<xsd:element name="CardNumber" type="xsd:string"/>
<xsd:element name="ExpirationDate" type="xsd:string"/>
<xsd:element name="SecurityCode" type="xsd:string"/>
<xsd:element name="CardAddress" type="ChargeCardAddressType"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: ChargeDetailType

Super-types: | None
Sub-types: | None

Name | ChargeDetailType
Abstract | no

XML Instance Representation
<...>
<pkup:ChargeCode> xsd:string </pkup:ChargeCode> [1]
<pkup:ChargeDescription> xsd:string </pkup:ChargeDescription> [0..1]
<pkup:ChargeAmount> xsd:string </pkup:ChargeAmount> [1]
<pkup:TaxAmount> xsd:string </pkup:TaxAmount> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="ChargeDetailType">
<xsd:sequence>
<xsd:element name="ChargeCode" type="xsd:string"/>
<xsd:element name="ChargeDescription" type="xsd:string" minOccurs="0"/>
<xsd:element name="ChargeAmount" type="xsd:string"/>
<xsd:element name="TaxAmount" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: FutureServiceDateType

Super-types: | None
Sub-types: | None

Name | FutureServiceDateType
Abstract | no

XML Instance Representation
<...>
<pkup:ServiceDate> xsd:string </pkup:ServiceDate> [1]
<pkup:CallByTime> xsd:string </pkup:CallByTime> [0..1]
<pkup:EarliestCloseTime> xsd:string </pkup:EarliestCloseTime> [0..1]
<pkup:LeadTime> xsd:string </pkup:LeadTime> [0..1]
<pkup:GWNIndicator> xsd:string </pkup:GWNIndicator> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="FutureServiceDateType">
<xsd:sequence>
<xsd:element name="ServiceDate" type="xsd:string"/>
<xsd:element name="CallByTime" type="xsd:string" minOccurs="0"/>
<xsd:element name="EarliestCloseTime" type="xsd:string" minOccurs="0"/>
<xsd:element name="LeadTime" type="xsd:string" minOccurs="0"/>
<xsd:element name="GWNIndicator" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: NotificationType

Super-types: | None
Sub-types: | None

Name | NotificationType
Abstract | no

XML Instance Representation
<...>
<pkup:ConfirmationEmailAddress> xsd:string </pkup:ConfirmationEmailAddress> [0..*]
<pkup:UndeliverableEmailAddress> xsd:string </pkup:UndeliverableEmailAddress> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="NotificationType">
<xsd:sequence>
<xsd:element name="ConfirmationEmailAddress" type="xsd:string" maxOccurs="unbounded" minOccurs="0"/>
<xsd:element name="UndeliverableEmailAddress" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: PendingStatusType

Super-types: | None
Sub-types: | None

Name | PendingStatusType
Abstract | no

XML Instance Representation
<...>
<pkup:PickupType> xsd:string </pkup:PickupType> [1]
<pkup:ServiceDate> xsd:string </pkup:ServiceDate> [1]
<pkup:PRN> xsd:string </pkup:PRN> [1]
<pkup:GWNStatusCode> xsd:string </pkup:GWNStatusCode> [0..1]
<pkup:OnCallStatusCode> xsd:string </pkup:OnCallStatusCode> [0..1]
<pkup:PickupStatusMessage> xsd:string </pkup:PickupStatusMessage> [1]
<pkup:BillingCode> xsd:string </pkup:BillingCode> [0..1]
<pkup:ContactName> xsd:string </pkup:ContactName> [0..1]
<pkup:ReferenceNumber> xsd:string </pkup:ReferenceNumber> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="PendingStatusType">
<xsd:sequence>
<xsd:element name="PickupType" type="xsd:string"/>
<xsd:element name="ServiceDate" type="xsd:string"/>
<xsd:element name="PRN" type="xsd:string"/>
<xsd:element name="GWNStatusCode" type="xsd:string" minOccurs="0"/>
<xsd:element name="OnCallStatusCode" type="xsd:string" minOccurs="0"/>
<xsd:element name="PickupStatusMessage" type="xsd:string"/>
<xsd:element name="BillingCode" type="xsd:string" minOccurs="0"/>
<xsd:element name="ContactName" type="xsd:string" minOccurs="0"/>
<xsd:element name="ReferenceNumber" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: PhoneType

Super-types: | None
Sub-types: | None

Name | PhoneType
Abstract | no

XML Instance Representation
<...>
<pkup:Number> xsd:string </pkup:Number> [1]
<pkup:Extension> xsd:string </pkup:Extension> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="PhoneType">
<xsd:sequence>
<xsd:element name="Number" type="xsd:string"/>
<xsd:element name="Extension" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: PickupAddressType

Super-types: | None
Sub-types: | None

Name | PickupAddressType
Abstract | no

XML Instance Representation
<...>
<pkup:CompanyName> xsd:string </pkup:CompanyName> [1]
<pkup:ContactName> xsd:string </pkup:ContactName> [1]
<pkup:AddressLine> xsd:string </pkup:AddressLine> [1..*]
<pkup:Room> xsd:string </pkup:Room> [0..1]
<pkup:Floor> xsd:string </pkup:Floor> [0..1]
<pkup:City> xsd:string </pkup:City> [1]
<pkup:StateProvince> xsd:string </pkup:StateProvince> [1]
<pkup:Urbanization> xsd:string </pkup:Urbanization> [0..1]
<pkup:PostalCode> xsd:string </pkup:PostalCode> [0..1]
<pkup:CountryCode> xsd:string </pkup:CountryCode> [1]
<pkup:ResidentialIndicator> xsd:string </pkup:ResidentialIndicator> [1]
<pkup:PickupPoint> xsd:string </pkup:PickupPoint> [0..1]
<pkup:Phone> PhoneType </pkup:Phone> [1]
</...>
Schema Component Representation
<xsd:complexType name="PickupAddressType">
<xsd:sequence>
<xsd:element name="CompanyName" type="xsd:string"/>
<xsd:element name="ContactName" type="xsd:string"/>
<xsd:element name="AddressLine" type="xsd:string" maxOccurs="unbounded"/>
<xsd:element name="Room" type="xsd:string" minOccurs="0"/>
<xsd:element name="Floor" type="xsd:string" minOccurs="0"/>
<xsd:element name="City" type="xsd:string"/>
<xsd:element name="StateProvince" type="xsd:string"/>
<xsd:element name="Urbanization" type="xsd:string" minOccurs="0"/>
<xsd:element name="PostalCode" type="xsd:string" minOccurs="0"/>
<xsd:element name="CountryCode" type="xsd:string"/>
<xsd:element name="ResidentialIndicator" type="xsd:string" default="N"/>
<xsd:element name="PickupPoint" type="xsd:string" minOccurs="0"/>
<xsd:element name="Phone" type="PhoneType"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: PickupDateInfoType

Super-types: | None
Sub-types: | None

Name | PickupDateInfoType
Abstract | no

XML Instance Representation
<...>
<pkup:CloseTime> xsd:string </pkup:CloseTime> [1]
<pkup:ReadyTime> xsd:string </pkup:ReadyTime> [1]
<pkup:PickupDate> xsd:string </pkup:PickupDate> [1]
</...>
Schema Component Representation
<xsd:complexType name="PickupDateInfoType">
<xsd:sequence>
<xsd:element name="CloseTime" type="xsd:string"/>
<xsd:element name="ReadyTime" type="xsd:string"/>
<xsd:element name="PickupDate" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: PickupPieceType

Super-types: | None
Sub-types: | None

Name | PickupPieceType
Abstract | no

XML Instance Representation
<...>
<pkup:ServiceCode> xsd:string </pkup:ServiceCode> [1]
<pkup:Quantity> xsd:string </pkup:Quantity> [1]
<pkup:DestinationCountryCode> xsd:string </pkup:DestinationCountryCode> [1]
<pkup:ContainerCode> xsd:string </pkup:ContainerCode> [1]
</...>
Schema Component Representation
<xsd:complexType name="PickupPieceType">
<xsd:sequence>
<xsd:element name="ServiceCode" type="xsd:string"/>
<xsd:element name="Quantity" type="xsd:string"/>
<xsd:element name="DestinationCountryCode" type="xsd:string"/>
<xsd:element name="ContainerCode" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: RateResultType

Super-types: | None
Sub-types: | None

Name | RateResultType
Abstract | no

XML Instance Representation
<...>
<pkup:RateType> xsd:string </pkup:RateType> [0..1]
<pkup:CurrencyCode> xsd:string </pkup:CurrencyCode> [0..1]
<pkup:ChargeDetail> ChargeDetailType </pkup:ChargeDetail> [0..*]
<pkup:TotalTax> xsd:string </pkup:TotalTax> [0..1]
<pkup:GrandTotalOfAllCharge> xsd:string </pkup:GrandTotalOfAllCharge> [1]
</...>
Schema Component Representation
<xsd:complexType name="RateResultType">
<xsd:sequence>
<xsd:element name="RateType" type="xsd:string" minOccurs="0"/>
<xsd:element name="CurrencyCode" type="xsd:string" minOccurs="0"/>
<xsd:element name="ChargeDetail" type="ChargeDetailType" maxOccurs="unbounded" minOccurs="0"/>
<xsd:element name="TotalTax" type="xsd:string" minOccurs="0"/>
<xsd:element name="GrandTotalOfAllCharge" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: ShipperType

Super-types: | None
Sub-types: | None

Name | ShipperType
Abstract | no

XML Instance Representation
<...>
<pkup:Account> AccountType </pkup:Account> [0..1]
<pkup:ChargeCard> ChargeCardType </pkup:ChargeCard> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="ShipperType">
<xsd:sequence>
<xsd:element name="Account" type="AccountType" minOccurs="0"/>
<xsd:element name="ChargeCard" type="ChargeCardType" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: SimpleAddressType

Super-types: | None
Sub-types: | None

Name | SimpleAddressType
Abstract | no

XML Instance Representation
<...>
<pkup:City> xsd:string </pkup:City> [0..1]
<pkup:StateProvince> xsd:string </pkup:StateProvince> [0..1]
<pkup:PostalCode> xsd:string </pkup:PostalCode> [0..1]
<pkup:CountryCode> xsd:string </pkup:CountryCode> [1]
</...>
Schema Component Representation
<xsd:complexType name="SimpleAddressType">
<xsd:sequence>
<xsd:element name="City" type="xsd:string" minOccurs="0"/>
<xsd:element name="StateProvince" type="xsd:string" minOccurs="0"/>
<xsd:element name="PostalCode" type="xsd:string" minOccurs="0"/>
<xsd:element name="CountryCode" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: StatusCodeDescriptionType

Super-types: | None
Sub-types: | None

Name | StatusCodeDescriptionType
Abstract | no

XML Instance Representation
<...>
<pkup:Code> xsd:string </pkup:Code> [1]
<pkup:Description> xsd:string </pkup:Description> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="StatusCodeDescriptionType">
<xsd:sequence>
<xsd:element name="Code" type="xsd:string"/>
<xsd:element name="Description" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: StreetAddressArtifactType

Super-types: | None
Sub-types: | None

Name | StreetAddressArtifactType
Abstract | no

XML Instance Representation
<...>
<pkup:StreetNumber> xsd:string </pkup:StreetNumber> [0..1]
<pkup:StreetPrefix> xsd:string </pkup:StreetPrefix> [0..1]
<pkup:StreetName> xsd:string </pkup:StreetName> [0..1]
<pkup:StreetType> xsd:string </pkup:StreetType> [0..1]
<pkup:StreetSuffix> xsd:string </pkup:StreetSuffix> [0..1]
<pkup:UnparsedStreetAddress> xsd:string </pkup:UnparsedStreetAddress> [0..1]
<pkup:StreetAddressArtifactSource> xsd:string </pkup:StreetAddressArtifactSource> [0..1]
<pkup:StreetAddressMatchCode> xsd:string </pkup:StreetAddressMatchCode> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="StreetAddressArtifactType">
<xsd:sequence>
<xsd:element name="StreetNumber" type="xsd:string" minOccurs="0"/>
<xsd:element name="StreetPrefix" type="xsd:string" minOccurs="0"/>
<xsd:element name="StreetName" type="xsd:string" minOccurs="0"/>
<xsd:element name="StreetType" type="xsd:string" minOccurs="0"/>
<xsd:element name="StreetSuffix" type="xsd:string" minOccurs="0"/>
<xsd:element name="UnparsedStreetAddress" type="xsd:string" minOccurs="0"/>
<xsd:element name="StreetAddressArtifactSource" type="xsd:string" minOccurs="0"/>
<xsd:element name="StreetAddressMatchCode" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: TodayType

Super-types: | None
Sub-types: | None

Name | TodayType
Abstract | no

XML Instance Representation
<...>
<pkup:LocalDate> xsd:string </pkup:LocalDate> [1]
<pkup:LocalTime> xsd:string </pkup:LocalTime> [1]
<pkup:CallByTime> xsd:string </pkup:CallByTime> [0..1]
<pkup:EarliestCloseTime> xsd:string </pkup:EarliestCloseTime> [0..1]
<pkup:LeadTime> xsd:string </pkup:LeadTime> [0..1]
<pkup:GWNIndicator> xsd:string </pkup:GWNIndicator> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="TodayType">
<xsd:sequence>
<xsd:element name="LocalDate" type="xsd:string"/>
<xsd:element name="LocalTime" type="xsd:string"/>
<xsd:element name="CallByTime" type="xsd:string" minOccurs="0"/>
<xsd:element name="EarliestCloseTime" type="xsd:string" minOccurs="0"/>
<xsd:element name="LeadTime" type="xsd:string" minOccurs="0"/>
<xsd:element name="GWNIndicator" type="xsd:string" default="N" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: TrackingDataType

Super-types: | None
Sub-types: | None

Name | TrackingDataType
Abstract | no

XML Instance Representation
<...>
<pkup:TrackingNumber> xsd:string </pkup:TrackingNumber> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="TrackingDataType">
<xsd:sequence>
<xsd:element name="TrackingNumber" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

### Complex Type: WeightType

Super-types: | None
Sub-types: | None

Name | WeightType
Abstract | no

XML Instance Representation
<...>
<pkup:Weight> xsd:string </pkup:Weight> [1]
<pkup:UnitOfMeasurement> xsd:string </pkup:UnitOfMeasurement> [1]
</...>
Schema Component Representation
<xsd:complexType name="WeightType">
<xsd:sequence>
<xsd:element name="Weight" type="xsd:string"/>
<xsd:element name="UnitOfMeasurement" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
top

## Legend

### Complex Type:

Schema Component Type

### AusAddress

Schema Component Name

Super-types: | Address < AusAddress (by extension)
Sub-types: | QLDAddress (by restriction)

If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.

Name | AusAddress
Abstract | no

The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia">
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

- The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
- Model group information are shown in gray, e.g. Start Choice ... End Choice.
- For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
- If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
- Otherwise, the type of the element/attribute is displayed.
  - If the element/attribute's type is in the schema, a link is provided to it.
  - For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
- If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base="Address">
<sequence>
<element name="state" type="AusStates"/>
<element name="postcode">
<simpleType>
<restriction base="string">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

## Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an `xsi:type` attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the `xsi:nil` attribute. The `xsi:nil` attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an `xsi:nil` attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top