GET Endpoint: Retrieves Orders from Your System
Descartes ShipRush Web will issue HTTP GET requests to the endpoint (URL) that you specify. This endpoint must return properly formatted XML to Descartes ShipRush Web.
Descartes ShipRush formats the URL as follows:
[Your URL]?SS-UserName=[username for authentication]&SS-Password=[password for authentication]&action=export&start_date=[Start Date]&end_date=[End Date]&page=1
SS-UserName |
When the Custom SS Store is created, you enter a username. This username is then passed into the request to your endpoint. |
SS-Password |
When the Custom SS Store is created, you enter a password. This password is then passed into the request to your endpoint. |
action |
Descartes ShipRush always passes "export" in this parameter. |
start_date |
The oldest data being requested. The start_date is specified in UTC time. Format: MM/dd/yyyy HH:mm (24-hour notation). For example: 04/23/2018 11:22.
Warning: Your system must respect this value and not return orders older than requested. |
end_date |
The last data for which Orders should be returned. The end-date uses the same format as start_date. The end-date should be mapped to an "order modified date" in your system, so that Descartes ShipRush Web can retrieve the latest information as Orders change. |
Warning: Always use an XML parser to create the XML. Do not create XML "by hand" in code. Always build an object in the appropriate schema, and convert the schema to XML via an XML library.
Paging
Any site that serves more than 50 orders a day should support paging.
Example Response to GET Command
<?xml version="1.0" encoding="utf-8"?>
<Orders pages="3">
<Order>
<OrderID>987456</OrderID>
<OrderNumber>ZC-490039</OrderNumber>
<OrderDate>3/8/2018 22:26 PM</OrderDate>
<OrderStatus>paid</OrderStatus>
<LastModified>3/8/2018 22:26 PM</LastModified>
<ShippingMethod>USPSPriority</ShippingMethod>
<PaymentMethod>Credit Card</PaymentMethod>
<OrderTotal>103.05</OrderTotal>
<TaxAmount>0.00</TaxAmount>
<ShippingAmount>6.50</ShippingAmount>
<CustomerNotes>Ship right away please!</CustomerNotes>
<InternalNotes>in afternoon batch</InternalNotes>
<Gift>false</Gift>
<GiftMessage/>
<CustomField1/>
<CustomField2/>
<CustomField3/>
<Customer>
<CustomerCode>customer@demouser.com</CustomerCode>
<BillTo>
<Name>Sally Buyeroff</Name>
<Company/>
<Phone>206-000-0101</Phone>
<Email>customer@demouser.com</Email>
</BillTo>
<ShipTo>
<Name>Sally Buyeroff</Name>
<Company/>
<Address1>120 Lakeside Ave</Address1>
<Address2>Suite 101</Address2>
<City>Seattle</City>
<State>WA</State>
<PostalCode>98122</PostalCode>
<Country>US</Country>
<Phone>206-000-0101</Phone>
</ShipTo>
</Customer>
<Items>
<Item>
<SKU>FLOP4433B</SKU>
<Name>Widget</Name>
<ImageUrl>http://www.mystoredemo.com/products/FLOP4433B.jpg</ImageUrl>
<Weight>4</Weight>
<WeightUnits>Ounces</WeightUnits>
<Quantity>3</Quantity>
<UnitPrice>15.91</UnitPrice>
<Location/>
<Options>
<Option>
<Name>Size</Name>
<Value>Large</Value>
<Weight>12</Weight>
</Option>
<Option>
<Name>Color</Name>
<Value>Green</Value>
<Weight>6</Weight>
</Option>
</Options>
</Item>
</Items>
</Order>
</Orders>Edit Web Store Options
Paid Status: Enter one or more string values that will be detected as Paid (e.g., new,paid,creditcard).
Signaling an Order is Cancelled/Should Not be Shipped
The following values when sent-in for an Order in Descartes ShipRush Web marks the order as "Cancelled":
cancelled,deleted,voided,refunded.