API Reference

Get shipments

The start and end date are used to identify shipments that were updated in the window. The returned response includes all shipments, including the shipped ones. Shipstation will handle duplicates.

<?xml version="1.0" encoding="utf-8"?>
<Orders pages="1">
  <Order>
    <!-- shipment.id -->
    <OrderID><![CDATA[123456]]></OrderID>

    <!-- shipment.sales[0].reference or shipment.sales[0].number -->
    <OrderNumber><![CDATA[ABC123]]></OrderNumber>

    <!-- shipment.planned_date -->
    <OrderDate>10/18/2019 21:56 PM</OrderDate>

    <!-- 
        shipment.state mapping - user can map these states on Shipstation UI

        assigned
        packed
        done 
    -->
    <OrderStatus><![CDATA[paid]]></OrderStatus>

    <!-- shipment.write_date -->
    <LastModified>12/8/2011 12:56 PM</LastModified>

    <!-- shipment.carrier.service -->
    <ShippingMethod><![CDATA[USPSPriorityMail]]></ShippingMethod>

    <!-- ignored -->
    <PaymentMethod><![CDATA[Credit Card]]></PaymentMethod>
    <OrderTotal>123.45</OrderTotal>
    <TaxAmount>0.00</TaxAmount>
    <ShippingAmount>4.50</ShippingAmount>
    <!-- end:ignored -->

    <CustomerNotes><![CDATA[Please make sure it gets here by Dec. 22nd!]]></CustomerNotes>
    <InternalNotes><![CDATA[Ship by December 18th via Priority Mail.]]></InternalNotes>

    <!-- if any lines have gift message -->
    <Gift>false</Gift>
    <GiftMessage></GiftMessage>

    <!-- shipment number -->
    <CustomField1></CustomField1>

    <!-- unused -->
    <CustomField2></CustomField2>
    <CustomField3></CustomField3>

    <Customer>
      <CustomerCode><![CDATA[[email protected]]]></CustomerCode>
      <BillTo>
        <Name><![CDATA[The President]]></Name>
        <Company><![CDATA[US Govt]]></Company>
        <Phone><![CDATA[512-555-5555]]></Phone>
        <Email><![CDATA[[email protected]]]></Email>
      </BillTo>
      <ShipTo>
        <Name><![CDATA[The President]]></Name>
        <Company><![CDATA[US Govt]]></Company>
        <Address1><![CDATA[1600 Pennsylvania Ave]]></Address1>
        <Address2></Address2>
        <City><![CDATA[Washington]]></City>
        <State><![CDATA[DC]]></State>
        <PostalCode><![CDATA[20500]]></PostalCode>
        <Country><![CDATA[US]]></Country>
        <Phone><![CDATA[512-555-5555]]></Phone>
      </ShipTo>
    </Customer>
    <Items>
      <Item>
        <SKU><![CDATA[FD88821]]></SKU>
        <Name><![CDATA[My Product Name]]></Name>
        <ImageUrl><![CDATA[http://www.mystore.com/products/12345.jpg]]></ImageUrl>
        <Weight>8</Weight>
        <WeightUnits>Ounces</WeightUnits>
        <Quantity>2</Quantity>
        <UnitPrice>13.99</UnitPrice>
        <Location><![CDATA[A1-B2]]></Location>

        <!-- options are not used -->
        <Options>
          <Option>
            <Name><![CDATA[Size]]></Name>
            <Value><![CDATA[Large]]></Value>
            <Weight>10</Weight>
          </Option>
          <Option>
            <Name><![CDATA[Color]]></Name>
            <Value><![CDATA[Green]]></Value>
            <Weight>5</Weight>
          </Option>
        </Options>
      </Item>
    </Items>
  </Order>
</Orders>

Bundles

When a shipment has a bundle, the bundle items also appear as line items on the main shipment.

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!