Importing Shipments into Shiptheory

This task will create new shipments in Shiptheory. The shipments must be supplied in an XML file.

Settings

Shiptheory Connection

Required
The Shiptheory connection to use. See the Connecting to Shiptheory article if you require more information on how to create/manage connections.

Fail File

Required
The name of a file for failed imports to be output to.

Input File

Required
The source file containing the shipments to import into Shiptheory. The file must be in the XML format shown below.

Success File

Required
The name of a file for successful imports to be output to.

Timeout

Optional
The length of time to wait (in seconds) for Shiptheory to respond to each API request. If left blank, or set to 0 or less, a default value of 100 seconds will be applied.

Zynk Settings

See Common Task Settings

Examples

A sample input file is shown below.

<?xml version="1.0" encoding="utf-8"?>
<Shipments xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Shipment>
    <ExternalId>ST0000001</ExternalId>
    <Reference>ST0000001</Reference>
    <Reference2>ST0000001</Reference2>
    <DeliveryServiceId>24</DeliveryServiceId>
    <DeliveryServiceIncrement>1</DeliveryServiceIncrement>
    <DeliveryServiceCarrier>Parcelforce</DeliveryServiceCarrier>
    <DeliveryServiceName>express48</DeliveryServiceName>
    <ShipmentDetail>
      <Weight>2</Weight>
      <Parcels>1</Parcels>
      <Value>20</Value>
      <ShippingPrice>2.99</ShippingPrice>
      <Reference3>ST0000001</Reference3>
      <Instructions>Please leave in porch</Instructions>
      <GiftMessage>Happy Birthday</GiftMessage>
      <ChannelShipserviceName>Express Delivery</ChannelShipserviceName>
      <CurrencyCode>GBP</CurrencyCode>
      <SalesSource>Magento</SalesSource>
      <ShipDate>2021-08-01</ShipDate>
      <RulesMetadata>express 48 hour</RulesMetadata>
      <DutyTaxNumber>12345689</DutyTaxNumber>
      <DutyTaxNumberType>ABN</DutyTaxNumberType>
    </ShipmentDetail>
    <Recipient>
      <Company>Zynk Software</Company>
      <Firstname>John</Firstname>
      <Lastname>Smith</Lastname>
      <AddressLine1>i6</AddressLine1>
      <AddressLine2>6-8 Charlotte Square</AddressLine2>
      <AddressLine3 />
      <City>Newcastle upon Tyne</City>
      <County>Tyne &amp; Wear</County>
      <Country>GB</Country>
      <Postcode>NE1 4XF</Postcode>
      <Telephone>0191 820 1484</Telephone>
      <Mobile></Mobile>
      <Email>[email protected]</Email>
      <TaxNumber>GB123456789</TaxNumber>
    </Recipient>
    <Sender>
      <Company>Zynk Software</Company>
      <Firstname>John</Firstname>
      <Lastname>Smith</Lastname>
      <AddressLine1>i6</AddressLine1>
      <AddressLine2>6-8 Charlotte Square</AddressLine2>
      <AddressLine3 />
      <City>Newcastle upon Tyne</City>
      <County>Tyne &amp; Wear</County>
      <Country>GB</Country>
      <Postcode>NE1 4XF</Postcode>
      <Telephone>0191 820 1484</Telephone>
      <Mobile></Mobile>
      <Email>[email protected]</Email>
      <TaxNumber>GB123456789</TaxNumber>
    </Sender>
    <Products>
      <Product>
        <Name>T-Shirt</Name>
        <Sku>TSHIRT</Sku>
        <Qty>1</Qty>
        <Value>20</Value>
        <Weight>2</Weight>
        <CommodityCode>12345678</CommodityCode>
        <CommodityDescription>T-Shirt</CommodityDescription>
        <CommodityManufactureCountry>GB</CommodityManufactureCountry>
      </Product>
    </Products>
    <Packages>
      <Package>
        <Id>1</Id>
        <Name>Small</Name>
        <Weight>2</Weight>
      </Package>
    </Packages>
  </Shipment>
</Shipments>