The shippingDetails
type defines how the purchased goods are shipped.
Example:
<shippingDetails>
<name>John Doe</name>
<address>
<street>Marxergasse</street>
<houseNumber>1b</houseNumber>
<postalCode>1030</postalCode>
<city>Vienna</city>
<countryCode2>AT</countryCode2>
<telephoneNumber>00437778889999</telephoneNumber>
</address>
<method>Express</method>
<firstname>John</firstname>
<lastname>Doe</lastname>
<email>[email protected]</email>
<deliveryType>CollectionPoint</deliveryType>
</shippingDetails>
Fields:
field (type, required) | description |
---|---|
name (personName, required) | The recipient full name Max 32 characters |
address (Address, required) | The recipient address |
method (string) | The shipping method, e.g. Express |
firstname (personName) | The first name of the recipient. Needed for specific payment methods, e.g. Klarna Deposit |
lastname (personName) | The last name of the recipient. Needed for specific payment methods, e.g. Klarna Deposit |
email (emailAddress) | The email address of the recipient. Needed for specific payment methods, e.g. Klarna Deposit |
deliveryType (shippingDeliveryType) | The type of delivery for example "CollectionPoint". Needed for specific payment methods, e.g. Klarna Deposit The allowed values for this field can be found on the relevant payment method documentation page. |
XML Schema:
<s:complexType name="shippingDetails">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="name" type="personName"/>
<s:element minOccurs="1" maxOccurs="1" name="address" type="address"/>
<s:element minOccurs="0" maxOccurs="1" name="method" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="firstname" type="personName" nillable="true"/>
<s:element minOccurs="0" maxOccurs="1" name="lastname" type="personName" nillable="true"/>
<s:element minOccurs="0" maxOccurs="1" name="email" type="emailAddress" nillable="true"/>
<s:element minOccurs="0" maxOccurs="1" name="deliveryType" type="shippingDeliveryType" nillable="true"/>
</s:sequence>
</s:complexType>