Additional Address

This section details optional additional address properties potentially required by certain carriers.

Address properties in this section are required in semi-structure format. If you choose to specify this object, some fields are mandatory.

Table 20. Additional Address Properties

Property Name

Type

Manda- tory?

Description

AddressKeyId

integer

0 = Billing Address, 4 = Requested Service point, 5 = importer of record (SOLD to).

Addressline1

string

1st line of address.

Postcode

string

Postcode.

City

string

City, if known.

countryCode

string

The countryCode defaults to the country associated with the default warehouse and must contain a valid entry. You can use an ISO 3166 Alpha-2, Alpha-3, or Numeric code.

Adressline2

string

2nd line of address.

Type

integer

Type 1 equals business and Type 2 equals residential.

stateProvince

string

State province if known.

CompanyName

string

Company name.

VATNumber

integer

Only valid for AddressKeyID=5

The VAT registration number of the Import of Record.

IOSSNumber

integer

Only valid for AddressKeyID=5

The IOSS is the electronic portal that online sellers outside the EU can use to calculate and collect VAT from their customers at an online checkout and declare and pay it directly to EU tax authorities. Although using the IOSS is not mandatory, it might be the most convenient way to manage this new VAT obligation.

EORINumber

integer

Only valid for AddressKeyID=5

EORI stands for “Economic Operators Registration and Identification”. An EORI number is mandatory for customs clearance in the customs territory of the European Union. That relates to all types of customs operations, such as export, import, and transit.

Email

string

Only valid for AddressKeyID=5Email address

Name

string

Only valid for AddressKeyID=5


For example:

...
<addresses soapenc:arrayType="ns1:ArrayOf_tns1_SemiStructuredAddress[1]" xsi:type="soapenc:Array">
                    <addresses xsi:type="ns1:ArrayOf_tns1_SemiStructuredAddress">
                        <addressKeyId>0</addressKeyId>
                        <addressLine1>line1</addressLine1>
                        <postCode>Gu34 2LZ</postCode>
                        <city>London</city>
                        <countryCode>GBR</countryCode>
                        <addressLine2>line2</addressLine2>
                        <type>2</type>
                        <stateProvince>Greater London</stateProvince>
                        <companyName>Metapack</companyName>
                    </addresses>
                </addresses>
...
<addresses soapenc:arrayType="ns1:ArrayOf_tns1_SemiStructuredAddress[1]" xsi:type="soapenc:Array">
                            <addresses xsi:type="ns1:ArrayOf_tns1_SemiStructuredAddress">
                                <addressKeyId>5</addressKeyId>
                                <addressLine1>Buckingham palace</addressLine1>
                                <addressLine2>line2</addressLine2>
                                <postCode>EC1R 4PF</postCode>
                                <city>London</city>
                                <countryCode>GBR</countryCode>
                                <type>2</type>
                              <stateProvince>Greater London</stateProvince>
                                <companyName>Metapack</companyName>
                                <name>Lorem Ipsum</name>
                                <phone>07412345678</phone>
                                <email>help@metapack.com</email>
                                <EORINumber>GB123456789</EORINumber>
                                <IOSSNumber>IM0123456789</IOSSNumber>
                                <VATNumber>GB99999973C</VATNumber>
                            </addresses>
                        </addresses>