Skip to content

Exporting Shipments from Shiptheory

This task will export shipments from Shiptheory to 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.

Carrier

Optional
Used to filter the export based on carrier. Leave blank to export shipments by all carriers, or select a particular carrier from the list to only export shipments by that carrier.

Channel

Optional
Used to filter the export based on sales channel, e.g. 'Magento'. Leave blank to export shipments from all channels, or enter a particular value to only export shipments from that channel.

Export Settings

Required

  • Date Created - When set to export new records, only records created after this date will be exported. The date will update automatically each time the task runs.
  • Date Modified - When set to export modified records, only records created or modified after this date will be exported. The date will update automatically each time the task runs.
  • Export Modified, New or All Records - Used to choose which records should be included in the export. Note that the 'Modified' setting will also export any new records.

Output File

Required
The name of the file to export the data to. The data will be output in XML format, a sample of which is shown below.

Page Size

Required
The number of records to fetch per page. This defaults to 100, and the maximum value is 100.

Status

Optional
Used to filter the export based on status. Leave blank to export shipments of all statuses, or select a particular status from the list to only export shipments of that status.

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

Sample output file:

<?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>99999</ExternalId>
    <Reference>12345</Reference>
    <Reference2>67890</Reference2>
    <DeliveryServiceId>20</DeliveryServiceId>
    <DeliveryServiceCarrier>Parcelforce</DeliveryServiceCarrier>
    <DeliveryServiceName>express24</DeliveryServiceName>
    <ShipmentDetail>
      <Weight>25</Weight>
      <Parcels>2</Parcels>
      <Value>514.5</Value>
      <ShippingPrice xsi:nil="true" />
      <EnhancementId xsi:nil="true" />
      <FormatId xsi:nil="true" />
      <Instructions />
      <ShipDate xsi:nil="true" />
      <TrackingNumber>AB012348567GB</TrackingNumber>
      <Grams>25000</Grams>
      <Width xsi:nil="true" />
      <Height xsi:nil="true" />
      <Depth xsi:nil="true" />
    </ShipmentDetail>
    <Recipient>
      <Company>Zynk Software</Company>
      <Firstname>John</Firstname>
      <Lastname>Smith</Lastname>
      <AddressLine1>i6</AddressLine1>
      <AddressLine2>6-8 Charlotte Square</AddressLine2>
      <City>Newcatle upon Tyne</City>
      <County>yne &amp; Wear</County>
      <Country>GB</Country>
      <Postcode>NE1 4XF</Postcode>
      <Telephone>01918201484</Telephone>
      <Mobile />
      <Email>[email protected]</Email>
    </Recipient>
    <Created>2021-07-06T13:36:27+01:00</Created>
    <Modified>2021-07-06T15:12:48+01:00</Modified>
    <ChannelName>Manual</ChannelName>
    <Status>Complete</Status>
  </Shipment>
</Shipments>