Skip to content

Exporting Shipments from ShipStation

This task will export shipments from ShipStation to an XML file.

Settings

ShipStation Connection

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

Export Order

Required
Set to 'True' to include the order related to each shipment in the export.

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.

Export Shipment Items

Required
Set to 'True' to include shipment item lines in the export.

Export Store

Required
Set to 'True' to include detailed store information for each order that is exported. When set to false, only the store ID will be exported.

Order IDs

Optional
Used to filter the export based on order ID. Leave blank to export shipments for any orders, or enter a comma separated list of order IDs to export shipments for specific orders. Please note that entering order IDs will override the Export Settings.

Order Numbers

Optional
Used to filter the export based on order number. Leave blank to export shipments for any orders, or enter a comma separated list of order numbers to export shipments for specific orders. Please note that entering order numbers will override the Export Settings.

Output File

Required
The name of the file to export the records 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 500.

Store ID

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

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>
    <Id>187978118</Id>
    <OrderId>336564688</OrderId>
    <OrderKey>6ba19052-7013-4e9f-bdc7-f7f427e02232</OrderKey>
    <UserId>6a01d6e8-c15a-4d24-83c0-330b5acf6076</UserId>
    <OrderNumber>984528</OrderNumber>
    <CreateDate>2019-02-26T06:57:33.427</CreateDate>
    <ShipDate>2019-02-27T00:00:00</ShipDate>
    <ShipmentCost>27.72</ShipmentCost>
    <InsuranceCost>124.20</InsuranceCost>
    <TrackingNumber>5984059944</TrackingNumber>
    <IsReturnLabel>false</IsReturnLabel>
    <CarrierCode>dhl_express_uk</CarrierCode>
    <ServiceCode>dhl_uk_domestic_express</ServiceCode>
    <PackageCode>package</PackageCode>
    <WarehouseId>610360</WarehouseId>
    <Voided>false</Voided>
    <VoidDate xsi:nil="true" />
    <MarketplaceNotified>true</MarketplaceNotified>
    <ShipTo>
      <Name>Mike Hayers</Name>
      <Company>Shipstation</Company>
      <Street1>8 Newcastle Enterprise Centres</Street1>
      <Street2>6 Charlotte Square</Street2>
      <City>Newcastle Upon Tyne</City>
      <State>Tyne and Wear</State>
      <PostalCode>NE1 4XF</PostalCode>
      <Country>GB</Country>
      <Phone>0845111 55 55</Phone>
      <Residential xsi:nil="true" />
    </ShipTo>
    <Weight>
      <Value>10.00</Value>
      <Units>grams</Units>
    </Weight>
    <Dimensions>
      <Units>inches</Units>
      <Length>1.00</Length>
      <Width>3.00</Width>
      <Height>4.00</Height>
    </Dimensions>
    <InsuranceOptions>
      <InsureShipment>false</InsureShipment>
      <InsuredValue>0.0</InsuredValue>
    </InsuranceOptions>
    <AdvancedOptions>
      <WarehouseId xsi:nil="true" />
      <NonMachinable xsi:nil="true" />
      <SaturdayDelivery xsi:nil="true" />
      <ContainsAlcohol xsi:nil="true" />
      <MergedOrSplit xsi:nil="true" />
      <MergedIds />
      <ParentId xsi:nil="true" />
      <StoreId>227725</StoreId>
    </AdvancedOptions>
    <ShipmentItems>
      <ShipmentItem>
        <OrderItemId>457619610</OrderItemId>
        <LineItemKey>0</LineItemKey>
        <Sku>SHIP1001</Sku>
        <Name>Shipstation</Name>
        <Weight xsi:nil="true" />
        <Quantity>1</Quantity>
        <UnitPrice>6900.00</UnitPrice>
        <ProductId>40548160</ProductId>
      </ShipmentItem>
    </ShipmentItems>
  </Shipment>
</Shipments>