Get Endpoint
Tip
New Version Coming Soon
This version of the Custom Store spec is still fully supported but a new version is coming soon. Both versions will be supported for some time.
To allow ShipStation access to your cart or marketplace so it can GET data, you must build your Custom Store endpoint to the specifications defined in this guide.
GET Call
ShipStation will make a GET API call to pull order information from the connected store.
ShipStation will request order information from the Web Endpoint you expose. It must render XML that adheres to the specification defined in the following sections.
GET Endpoint URL
ShipStation will use the following URL format when requesting order information from the Web Endpoint you build:
[Your Web Endpoint]?action=export&start_date=[Start Date]&end_date=[End Date]&page=1 [Your Web Endpoint]?action=export&start_date=[Start Date]&end_date=[End Date]&page=1
Here is a description of each URL parameter:
Parameter | Description |
---|---|
action |
This value will always be "export" when ShipStation is requesting order information. |
start_date |
The start date in UTC time. Format: MM/dd/yyyy HH:mm (24 hour notation). For example: 03/23/2012 21:09 |
end_date |
The end date in UTC time. Same format as start_date. |
Your page should return data for any order that was modified between the start and end date, regardless of the order's status. The order data should be returned in an XML format as shown in the following example. All free text fields should be enclosed in a CDATA section to ensure there aren't any parsing errors.
A CDATA section starts with "".
Example GET Response Body
Below is an example of the XML response body that ShipStation is expecting when a GET call is made for order information. You can find detailed definitions of the fields in the Custom Store Reference Guide.
<?xml version="1.0" encoding="utf-8"?>
<Orders pages="1">
<Order>
<OrderID><![CDATA[123456]]></OrderID>
<OrderNumber><![CDATA[ABC123]]></OrderNumber>
<OrderDate>10/18/2019 21:56 PM</OrderDate>
<OrderStatus><![CDATA[paid]]></OrderStatus>
<LastModified>12/8/2011 12:56 PM</LastModified>
<ShippingMethod><![CDATA[USPSPriorityMail]]></ShippingMethod>
<PaymentMethod><![CDATA[Credit Card]]></PaymentMethod>
<OrderTotal>123.45</OrderTotal>
<TaxAmount>0.00</TaxAmount>
<ShippingAmount>4.50</ShippingAmount>
<CustomerNotes><![CDATA[Please make sure it gets here by Dec. 22nd!]]></CustomerNotes>
<InternalNotes><![CDATA[Ship by December 18th via Priority Mail.]]></InternalNotes>
<Gift>false</Gift>
<GiftMessage></GiftMessage>
<CustomField1></CustomField1>
<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>
<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>
<Item>
<SKU></SKU>
<Name><![CDATA[$10 OFF]]></Name>
<Quantity>1</Quantity>
<UnitPrice>-10.00</UnitPrice>
<Adjustment>true</Adjustment>
</Item>
</Items>
</Order>
</Orders>