ShipRush
ShipRush Dashboard
Submit an Idea
Contact Support

Endpoint

/shipmentservice.svc/shipments/updatebulk


Request

Sample

Parameter

Required

Description

Requests

Y

List of update transaction to execute

 
<UpdateShipmentRequest>
<Requests>
<TRequest>
<ShipmentId>9eff1e21-20ab-489e-94cd-9c25009799e8</ShipmentId>
<ShippingCharges>7.55</ShippingCharges>
<TrackingNumber>1Z1234567890</TrackingNumber>
<MarkAsShipped>true</MarkAsShipped>
<ShipDate>2009-09-25T16:45:00.000Z</ShipDate>
</TRequest>
</Requests>
</UpdateShipmentRequest>


DeleteShipment()

This function delete shipment from MyShipRush base on Tracking number


Endpoint - DeleteShipment()

/shipmentservice.svc/shipments/delete/<trackingNumber>


Request - DeleteShipment()

Sample

Parameter

Required

Description

TrackingNumber

N


shipmentRequest

N

Transaction to execute

 
<shipmentRequest>
<ShipTransaction>
<TShipTransaction>
<Shipment>
<ShipmentId>542f4e14-97c3-4c73-b909-9d5a009c0d87</ShipmentId>
</Shipment>
</TShipTransaction>
</ShipTransaction>
</shipmentRequest>


GetMyShipRushTime()

Returns current MyShipRush current time. Useful for querying shipments that are at least few minutes old.


Endpoint - GetMyShipRushTime()

/accountservice.svc/time/get


Request - GetMyShipRushTime()

none


Response - GetMyShipRushTime()

<GetMyShipRushTimeResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MyShipRushTime>2009-09-25T16:45:00.000Z</MyShipRushTime>
</GetMyShipRushTimeResponse>

It is important to allow a 5 minute overlap. This means two things:

  1. Do not query up-to-the-minute-of-GetMyShipRushTime(). Rather, reduce this time by 5 minutes to avoid data that is actively being updated and possibly incomplete.

  2. Overlap query windows by 5 minutes. For example, if the first query is from 1:00 to 2:00, the second query should be from 1:55 to 3:00, etc.


System IDs

Order IDs

A given order has multiple identifiers. It is important to understand what is what.

  • OrderId: Internal My.ShipRush identifier. This is a GUID and is generated by My.ShipRush. It is guaranteed to be unique, however, it is not "externally reference-able" (e.g., it does not appear in the ecommerce system). Displaying this ID in your UI is useless and will not help merchants do their jobs.

  • OrderNumber: This is a user-friendly (reference-able) order number that comes from eCommerce system. You can query My.ShipRush for a specific OrderNumber via the GetShipments() call.

  • Where does OrderNumber come from?

    • Amazon: On Amazon it is the Order Number. Amazon order numbers look like this: 104-2926476-9349813

    • eBay: On eBay it is the ItemID. For single-quantity sales on eBay, this is unique, reference-able, and the best ID to use. However on multi-quantity sales, the My.ShipRush OrderNumber will still be the ItemID, which is now no longer unique (as it will appear on multiple sales). In these cases, the eBay Transaction ID should be referenced. The eBay TransactionID is an easily parseable component of the My.ShipRush ExternalID field.

    • OrderNumber is not guaranteed to be unique and on eBay Web Store types often will not be unique.

    • Yahoo: Yahoo has the potential to issue duplicate OrderNumbers, because Yahoo allows the user to reset the order number counter.

    • On other ecommerce systems OrderNumber is the order number.

  • ExternalId: eCommerce friendly order number that comes from eCommerce system. Used internally to identify item on the eCommerce system. While My.ShipRush does guarantee ExternalId to be unique, we expect that it will be for nearly all sellers. For Amazon sales, this is the OrderNumber. On eBay it is the UserId + ItemId + TransactionId (separated by space). On other ecommerce systems it is the OrderNumber. Note that when referencing eBay transactions, you need to "do the right thing" when displaying ID's. In some cases, ItemId = TransactionId, and in some cases not.

  • ShipTransactions\TShipTransaction\Order\AlternateOrderNumber: This is an eBay relevant number and maps to the eBay Selling Manager "Record #" column. This number is useful to eBay sellers who use eBay's Selling Manager. Here is a screen shot of the eBay Selling Manager:

Beware that as of Q1 2010, not all eBay sellers use or have access to Selling Manager. While it is free of charge, the seller must take extra steps to activate it and access it.

  • ShipTransactions\TShipTransaction\Order\ExternalTransactionId: This is an eBay relevant number and maps to the eBay Transaction\ExternalTransaction\ExternalTransactionID element. Optionally, your system may use this element to group items into a single order. Due to weaknesses in the eBay system, you should ignore the contents of this element if it has a length of less than 8.

Tip: During testing, it is common to re-use same test Web store over and over with different My.ShipRush user accounts. This is OK, but you will have multiple copies on the same orders under different user accounts. Make sure to reference orders by OrderId NOT OrderNumber. Note: If the same Web store is used within a single My.ShipRush user ID, each order will only be retrieved once, total, for the user ID. If the same ZenCart store is created twice for a give My.ShipRush user, each instance of the store will have some of the orders, and neither store will have all of the orders. This is by design, to avoid order duplication.


Shipment IDs

There are two different IDs that can identify a Shipment in My.ShipRush

  • ShipmentId: Internal identifier. This is a GUID, generated by My.ShipRush and guaranteed to be unique.

  • TrackingNumber: Carrier-friendly way of identifying shipment. It is not guaranteed to be unique. The same shipment can be logged in My.ShipRush under different user accounts, plus carriers will reuse tracking numbers every few years (and carrier hiccups can duplicate tracking numbers more often than that).

A given order can have multiple shipments, but each shipment belongs to only one order. You can always derive OrderId from ShipmentId but not the other way around.


Persisting My.ShipRush IDs

Do not build compound keys based on unique My.ShipRush IDs.

A key part of My.ShipRush is to avoid representing a given order more than once. It is possible that a given OrderID will change from one WebStoreID to another. Avoid building a compound key to identify an order. Identify an order by the My.ShipRush OrderID.


Acceptable Encryption for Access Tokens

Certain tokens are persisted by you, the My.ShipRush API developer. Acceptable encryption methods are:

  • Web Application: Server side, on your servers. If My.ShipRush tokens are as secure as your own server-side access methods, that is acceptable.

  • Desktop Application: Server side, on your servers. If My.ShipRush tokens are as secure as your own server-side access methods, that is acceptable.

  • Desktop Application: Client side, use a crypto method that is per-user based, or per PC based. Do not use a static, global encryption key.


Encryption Notes

Encryption must be strong, with salt. We advise using a long salt element of 20 or more digits.


Interpreting Orders & Shipments

How to Read Shipped Status via GetShipments()

Orders may flow in to ShipRush with a shipped status from the ecommerce system. This is particularly relevant when a Web store is newly set up. The retrieved orders may be a mix of shipped and unshipped orders.

For such orders, Descartes ShipRush will usually not know the tracking number. But the shipped status is returned in the GetShipments() response.

The area of interest is: <ShipmentType>History</ShipmentType>

<TShipTransaction>
<Shipment>
<ShipDate>2010-04-16T23:28:10.000Z</ShipDate>
<Carrier>1</Carrier>
<IsProcessed>0</IsProcessed>
<PartnerId>eBay</PartnerId>
<InsuranceProvider>Carrier</InsuranceProvider>
<Package>
<PackageActualWeight>15</PackageActualWeight>
<PackagingType>02</PackagingType>
</Package>
<DeliveryAddress>
<Address>
<FirstName>Jennifer</FirstName>
<LastName>VanDeKamp</LastName>
<Address1>999 W CENTRAL TEXAS EXPY APT 4999</Address1>
<City>KILLEEN</City>
<State>TX</State>
<Country>US</Country>
</Address>
</DeliveryAddress>
<ShipmentId>542f4e14-97c3-4c73-b909-9d5a009c0d87</ShipmentId>
<ShipmentStatus>Unknown</ShipmentStatus>
<ShipmentType>History</ShipmentType>
</Shipment>

The <ShipmentType>History</ShipmentType> element tells you that this is a "shipped" order. If it was shipped in eBay, or some place outside of the ShipRush world, we will not have track #.

"ShipmentType" values:

  • Pending = not shipped

  • History = shipped


Weight, Dimensions, Units of Measure (UOM)

Generally, ecommerce systems vary in their support for weight and dims. Many systems lack this information. Those that have the data structures, often find that the system user (the merchant) has not populated that data, or it is not reliable. Bottom line: Are weight and dim data in the ecommerce system?


Weight and Dims Are Surfaced in Two Places

Order / Shipment Level

Dims are not going to be ideal for multi-line-item orders and multi-qty.

Note that UOM are declared at the Order/Shipment level:

  • UnitsOfMeasureWeight

  • UnitsOfMeasureLinear

OrderItem level contains weight and dims for each line item. (Where supported by and, present in, ecommerce system.)

  • ShipmentOrderItem.ItemLength

  • ShipmentOrderItem.ItemWidth

  • ShipmentOrderItem.ItemHeight


Multi Currency Support

The My.ShipRush platform and API is multi-currency. Where supported by the ecomm system, the currency type will be returned.

  • Order.Currency: Always returned

  • Shipment.CurrencyCode: This is only returned when the request includes "ReturnExtendedShipmentFields" (this is demonstrated in build 86446+ of ShipRush.SDK.Console_BigDemoApp)

Note: Some (especially older) PHP carts and other systems do not pass a currency type. In these cases, you need to "know" on the consuming side.


Custom Web Stores

??


Merchant Capabilities (as of September, 2014)

Merchant are different from each other in terms of which data and how they allow us to see. The table below summarizes these differences.

  • Order Status: Ecommerce systems have different numbers and names for the statuses of orders. For example, Magento and Zen Cart have four to five statuses. Amazon has essentially one status. The My.ShipRush platform homogenizes these statuses for purposes of shipping to two basic vectors: Paid/Not-Paid and Shipped/Not-Shipped.

The Look Back Range, Delay and other specs below are worst case/minimum deliverable. Actual performance is generally better, more and faster.

Column1

Payment Status

Shipping Carrier & Service***

Weight

Dims

Multi addresses per order supported?

Configured Web store: Download Delay*

Kickstarter

Y

NA

NA

NA

Y

2-10 min

Finale Inventory

Y

Y

Y

NA

Y

2-10 min

Shopware

Y

NA

Y

Y

Y

2-10 min

UltraCart

Y

Y

Y

Y

Y

2-10 min

Discogs

Y

N

Y

NA

Y

2-10 min

Zenventory

Y

NA

NA

NA

NA

2-10 min

Zentail

Y

Y

NA

NA

Y

2-10 min

ExchnageWP

Y

Y

NA

NA

Y

2-10 min

Wish

Y

N/A

N/A

N/A

Y

2-10 min

Overstock

N/A

N/A

N

N/A

Y

2-10 Min

SellerCloud

Y

N/A

N/A

N/A

N/A

2-10 Min

Shopp

Y

N/A

N/A

N/A

N/A

2-10 min

Infusionsoft

Y

N/A

N/A

N/A

Y

2-10 min

Reverb

Y

N/A

N

N

Y

2-10 min

SAP Anywhere

Y

N/A

N

N

Y

2-10 min

Netsuite

Y

Y

Y

N/A

Y

2-10 min

Brandboom

Y

Y

N/A

N/A

Y

2-10 min

Goodsie

Y

Y

N/A

N/A

NA

2-10 min

Bandcamp

Y

N/A

N/A

N/A

N

2-10 min

SureDone

Y

Y

Y

N/A

Y

2-10 min

Cratejoy

Y

N/A

Y

N/A

N/A

2-10 min

PinnacleCart

Y

N

Y

N/A

N

2-10 min

Groupon Store

N/A

N/A

N/A

N/A

N/A

Instant Upload

WP-eCommerce

Y

Y

NA

NA

N/A

2-10 min

Pricefalls

Y

Y

NA

N

N/A

30-60min

Stitch Labs

Y

Y

Y

N

N/A

2-10 min

Ecwid

Y

Y

Y

N

N/A

2-10 min

Jigoshop

Y

Y

Y

Y

N/A

2-10 min

Jet

Y

N

N

N

N

2-10 min

LemonStand

Y

N

N

N

N

2-10 min

Groupon

Y

Y

N

N

N

2-10 min

Bonanza

Y

Y

N

N

Y

2-10 min

Walmart

N (all paid)

Y

N

N

N

2-10 min

HikaShop

Y

Y

Y

N

Y

2-10 min

Square

Y

NA

NA

NA

N

2-10 min

SkuVault

Y

NA

Y

NA

N

2-10 min

Handshake

Y

Y

NA

NA

Y

2-10 min

Craft Commerce

Y

Y

Y

Y

Y

2-10 min

Mijoshop

Y

Y

Y

Y

Y

2-10 min

Stripe

Y

Y

Y

Y

NA

2-10 min

Americommerce / Sparkpay

Y

Y

Y

Y

NA

2-10 min





(first item's dims are used)



Yahoo

N,

N

N

N

NA

2-10 min


(like most ecomm systems, orders are, by definition, paid)






eBay

Y

Y

Y**

Y**

NA

2-10 min

PayPal

E-Check or PayPal

N

N

N

NA

2-10 min

Amazon

N, assumed paid

"Standard" or "Express"

N

N

NA

5-15 minutes*****

Zen Cart

Y

Ship service mapping is customizable.

Y

N

NA

2-10 min

X-Cart

Y

Ship service mapping is customizable.

Y

N

NA

2-10 min

OsCommerce

Y

Ship service mapping is customizable.

N

N

NA

2-10 min

Magento

Y

Ship service mapping is customizable.

Y

N

NA

2-10 min





(stock Magento 1.x does not support item or order dims - Default magento installation does not support dimensions. Case 49923)



CRE Loaded

Y

Ship service mapping is customizable.

N

N

NA

2-10 min

Volusion

Y

Only if match found



NA

2-10 min

Custom Web Store: Polling based

Y

Only if match found

Y

N

NA

2-10 min

BigCommerce

Y

If matched

Y

Y

Y

2-10 min



Customizable mapping in My.ShipRush


(if enabled on Web Store, Case 54240)



ASPDotNetStorefront

Y

Only if match found

N

N

NA

2-25 min

Etsy

Y

N

N

N

NA

2-10 min

ChannelAdvisor

Y

N

N

N

NA

2-10 min

Buy.com

N, assumed paid

"Expedited" or "Standard" only

N

N

NA

2-10 min

CS-Cart

Y

Ship service mapping is customizable.

Y

N

NA

2-10 min

Sears.com

Y

Service: Yes

N

N

NA

2-10 min



Carrier: No





Magento Native (rarely used)

Y

Service: Yes

N

N

NA

2-10 min



Carrier: No





Prestashop

Y

Service: Yes

Y

N

NA

2-10 min



Carrier: Yes





QuickBooks Desktop

NA

NA

N

N

NA

1-15 mins User configurable in QB Web Connector.

3dcart

Y

Y

Y

N

Y

2-10 min





(3dcart limitation)



OpenCart

Y

Y

Y

N


2-10 min

Shopify

Y

Y

Y

N

NA

2-10 min

QuickBooks Online

Invoice COD type can be detected and acted on

N/A

N/A

N/A

Y

2-10 min

Big Cartel

Y

N/A

N/A

N/A


2-10 min

Authorize.Net

Y

N/A

N/A

N/A


2-10 min

Column2

Are Old Orders Downloaded?

New store creation: Look Back Range ******

Orders are Updated with Shipment Info

Cancelled orders:

Marked "shipped" on the ecommerce system:

Is the Order Status in My.ShipRush changed after the Order is cancelled ?

Setup Ease*






Can My.ShipRush identify them?







downloaded on initial order import?


What is the new order status in My.ShipRush ?







Cancelled on ecommerce system: Does My.SR detect order cancellation on ecommerce?









(does this change paid status ?)


Kickstarter

y

Standard

No

NA

NA

NA

4

Finale Inventory

y

Standard

Y

NA

Y

Y

2












Status (nothing else)





Shopware

Y

Standard

Y

NA

Y

NA

3












Tracking, Status





UltraCart

Y

Standard

Y

N/A

Y

N/A

4












Tracking, Cost, Service, Status





Discogs

Y

Standard

Y

Y

Y

Y

2












Tracking, Cost, Status





Zenventory

Y

Standard

Y

NA

Y

NA

2




Tracking, Status, Shipping Cost


NA



Zentail

Y

Standard

Y

N/A

Y

Y

2




Status, Ship Method, Carrier, Tracking Number, Date










Y



ExchnageWP

Y

Standard

Y

N/A

Y

Y

4






Y






Number, date, service, carrier





Wish

Y

Standard

Y

N/A

N

N/A

1












Status only





Overstock

Y

Standard

Y

N/A

N

N/A

1




Status, Tracking #, Carrier





SellerCloud

Y

Standard

Y

N/A

Y

N/A

1

Shopp

Y

Standard

Y

N/A

Y

N/A

3

Infusionsoft

Y

Standard

N

N/A

N

N

1

Reverb

Y

Standard

Y

N/A

Shipped: Y

Y

1




Tracking


Cancelled: N/A






Marked as Shipped





SAP Anywhere

Y

Standard

Y

N/A

Shipped:

N

1




Tracking


Cancelled: N/A






Mark as Shipped





Netsuite

Y

Standard

Y

N/A

Shipped: N

N

5




Tracking


Cancelled: N/A



Brandboom

Y

2 days

Y: Method

N/A

Shipped: N

N

2



Full Refresh = 7 days

Marked as shipped


Cancelled: N/A






Tracking





Goodsie

Y

2 days

Y:

N/A

Shipped N

N

1



Full Refresh = 7 days

Shipping Method


Cancelled: N






Marked as Shipped








NO TRACKING





Bandcamp

Y

2 days

Marked as shipped

Y

Shipped: Y

Y

1



Full Refresh = 7 days



Cancelled: Y






No Tracking or Cost





SureDone

Y

2 days

Y,

Y

Shipped: Y

Y

2



Full Refresh = 7 days

Tracking


Cancelled: Y






Ship Method





Cratejoy

Y

2 days

Y,

Y

Shipped N

Doesn't change

3



Full Refresh = 7 days

Tracking


Cancelled: N



PinnacleCart

Y

2 days

N (Not supported by API currently)

Y

Shipped: Y

N

2



Full Refresh = 7 days



Cancelled: Y



Groupon Store

Y

Works like Excel

Y,

N/A

N/A

N

2




Tracking





WP-eCommerce

Y

2 days

Y,

N

Shipped: N

N

3



Full Refresh = 7 days

Tracking


Cancelled: N



Pricefalls

Y

2 days

Y,

N/A

Shipped: N

N/A

5



Full Refresh = 7 days

Tracking #, Cost


Cancelled: N/A



Stitch Labs

Y

2 days

Y,

Y

Shipped: Y

Y

2



Full Refresh = 7 days

Tracking #, Cost


Cancelled: Y



Ecwid

Y

2 days

Y

Y

Shipped: Y

Y

1



Full Refresh = 7 days

Tracking #, Cost


Cancelled: Y



Jigoshop

Y

2 days

Y

Y

Shipped: Y

Y

3



Full Refresh = 7 days

Tracking #, Cost


Cancelled: Y



Jet

Y

2 days

Y

N

Shipped: Y

NA

3



Full Refresh = 7 days

Tracking #, cost


Cancelled: N/A



LemonStand

Y

2 days

Y

N

Shipped: Y

Y

2



Full Refresh = 7 days

Tracking #


Cancelled: Y



Groupon

Y

2 days

Y

Y

Shipped: Y

Y

3



Full Refresh = 7 days

Tracking #


Cancelled: N/A



Bonanza

Y

2 days

Y

Y

Shipped: Y

Y

1



Full Refresh = 7 days

Tracking #, cost


Cancelled: Y



Walmart

Y

2 days

Y

Y

Shipped: Y

Y

3



Full Refresh = 7 days

Tracking #, cost


Cancelled: Y



HikaShop

Y

2 days

Y

Y

Shipped: Y


3



Full Refresh = 7 days

Tracking #, cost, service


Cancelled: Y



Square

Y

2 days

Y

Y

Shipped: Y


1



Full Refresh = 7 days

Tracking #, cost, service


Cancelled: Y



SkuVault

Y

2 days

Y

Y

Shipped: Y

Y

1



Full Refresh = 7 days

Tracking #, Cost


Cancelled: NA



Handshake

Y

2 days

Y

Y

Shipped: Y


1



Full Refresh = 7 days

Tracking #, service, cost


Cancelled: Y



Craft Commerce

Y

2 days

Y

Y

Shipped: Y


3



Full Refresh = 7 days

Tracking #, service


Cancelled: Y



Mijoshop

Y

2 days

Y

Y

Shipped: Y


3



Full Refresh = 7 days

Tracking #, service


Cancelled: Y



Stripe

Y

2 days

Y

NA

Shipped: Y

NA

Ameri



full refresh = 7 days









Tracking #, service, cost


Cancelled: NA



Americommerce / Sparkpay

Y

7 Days

Y

Y

Shipped: Y

Y

2




track # & shipping service










Order status changes to Shipped will be retrieved to My.ShipRush
















Cancelled: Y



Yahoo

Y

Set by user in Web store creation (initial order #)

Y

Y

Shipped: Y

Not Changed

2




track # & shipping service










Order status changes to Shipped will be retrieved to My.ShipRush. (In some cases this can be delayed 1-2 hours, based on Yahoo system behavior.)
















Cancelled: Y



eBay

Y

2 days (full refresh = 7 days)

Y

N

Shipped: Y

NA

1




track #: Visible to buyer and seller










Cancelled: Not currently detected due to eBay API limitation (ZF Case 32690)






Estimated shipping cost: Visible only to seller, and only if using Selling Manager Pro





PayPal

Y

2 days (full refresh = 7 days)

N

Y

Shipped: PayPal does not return a shipped flag.

Paid

2






All orders, shipped & unshipped come down and look alike.
















Cancelled:



Amazon

Y

2 days (full refresh = 7 days)

Y,

N

Shipped: Y

Y

1




During peak volume on Amazon, there can be a delay of 2-4 hours before








track #, shipping carrier & service are seen in amazon.com****


Orders marked as Shipped in Amazon do not flow into My.ShipRush






Note: Amazon does not allow future ship date. Shipment date always set to "today." (Amazon limitation.)










Cancelled: Y



Zen Cart

Y

2 days (full refresh = 7 days)

Y

NA

Shipped: Y

Y

3




track #










Order status changes to Paid and Shipped status will be retrieved as long as these changes happen within 30 days of the order creation date.








Order statuses can be excluded via the ShippingZSettings.php
















Cancelled:



X-Cart

Y

2 days (full refresh = 7 days)

Y


Shipped: Y


3




track #










Note that the status change needs to happen within 12 hours of order creation time.








Order statuses can be excluded via ShippingZSettings.php
















Cancelled:



OsCommerce

Y

2 days (full refresh = 7 days)

Y

NA

Shipped: Y


3




track #


















Order status changes to Paid and Shipped








status will be retrieved as long as these








changes happen within 30 days of the order creation date.








Order statuses can be excluded via the ShippingZSettings.php
















Cancelled:



Magento

Y

2 days (full refresh = 7 days)

Y

Y

Shipped: Y


3




track #










Order status changes to Paid and Shipped status will be retrieved as long as these changes happen within 30 days of the order creation date.








Order statuses can be excluded via the ShippingZSettings.php
















Cancelled: Y
















Order status in MySR changes to Cancelled. (ZF Case 42725)



CRE Loaded

Y

2 days (full refresh = 7 days)

Y

N

Shipped: Y


3




track #










Configurable in ShippingZSettings.php
















Cancelled:



Volusion

Y

New orders after setup only

Y

N

Shipped: Y

Y

3




track #







or (depending on Web store options selected in My.SR)



See the Volusion help topics on My.ShipRush for detail.













All orders of selected statuses. (Volusion API does not support selection by date period.)



Cancelled:

Changes to Unpaid


Custom Web Store: Polling based

Y

Customizable in php code

Y


Customizable, depends on implementation.






track #








(customizable in php code)





BigCommerce

Y

2 days (full refresh = 7 days)

Y

Y

Shipped: Y

Y

3














Cancelled:

Changes to Unpaid


ASPDotNetStorefront

Y

2 days (full refresh = 7 days)

Y


Shipped:


4



(Only orders of "ready to ship" status are retrieved)

track #










Cancelled:



Etsy

Y

2 days (full refresh = 7 days)

Y

Y - Cancel is Pending in Etsy

Shipped: Y


1




Marked as shipped, Track # and service written to "Notes from shop" area of order.










Cancelled:



ChannelAdvisor

Y

2 days (full refresh = 7 days)

Y


Shipped:


3




track #










Cancelled:



Buy.com

Y

2 days (full refresh = 7 days)

Y

NA

Shipped: N


3




track #










Cancelled:



CS-Cart

Y

2 days (full refresh = 7 days)

Y

N

Shipped: Y


3




track #










Only if the status changes within 12 hours of order creation time.








Order statuses can be excluded via ShippingZSettings.php
















Cancelled:



Sears.com

Y

2 days (full refresh = 7 days)

Y

Y - not as Pending on initial download

Shipped: Y

Status isn't changed. Order is lined out, ie

1




Track # and service









Second refresh shows as cancelled

Cancelled: Y

Order 12345


Magento Native (rarely used)

Y

2 days (full refresh = 7 days)

Y

Y

Shipped:


3




Track # and service










Cancelled:



Prestashop

Y

2 days (full refresh = 7 days)

Y


Shipped:


3




Track # and service










Cancelled:



QuickBooks Desktop

Y

7 days

Y


NA: No such flag in QB


3










up to 7 days


Track # and service, configurable in settings.





3dcart

Y

2 days (full refresh = 7 days)

Y

Y

Shipped: Yes


3














Cancelled: Yes



OpenCart

Y

2 days, 7 in full refresh

Y

N

Shipped: no

N

3














Cancelled: no



Shopify

Y

2 days, 7 in full refresh

Y

Y

Shipped


2






Cancelled



QuickBooks Online

Y

2 days, 7 in full refresh

Y

N/A

N/A - There are no order statuses in QBO, just invoices/sales receipts, etc.

N/A

1

Big Cartel

Y

2 days, 7 in full refresh

Y


Y


1

Authorize.Net

Y

2 days, 7 in full refresh

N/A


N/A


3

* Key for Set Up Ease

1 - Anyone who can log in or use the ecommerce system can set up the shipping integration. Zero technical expertise needed.

2 - Same as 1, but the user will need to read a few sentences and open the ecommerce system in a separate browser window to copy information into the My.ShipRush screen.

3 - Same as #2, but the ecommerce system is harder to navigate, and/or user needs to read more than two or three sentences/steps of the My.SR docs in order to do the setup. For PHP carts, FTP access is reqd to their Web store. In the vast majority of cases a Web master is NOT needed (thanks to new ftp setup built in to My.ShipRush).

4 - Technical involvement required that not all users will have. For example, a Web master or other technical resource is usually needed for setup.

5 - Super technical, for developers.

Note: NA - Not Applicable

Ease and Speed of Setup is rated on a 1-5 scale, with one being "dead easy" and 5 being "rather involved and technical - not for .com users"

Additionally, note that we are working on bringing the 4's and 3's down! This is an ongoing project. The PHP carts are now mostly set up via a simple high level wizard.

* Download Delay: This relates to the delay observed during ongoing use (after the initial setup). It is the delay from when a new order is placed on the ecommerce system to when it shows up in ShipRush. Some of this delay is mechanical. For example, Amazon does not surface new orders to sellers for at least 30 minutes after payment. Generally My.ShipRush hides orders that are not paid yet (common on eBay, less common on other systems), and the delay is based on when payment occurs.

Note that users who do not interact with My.ShipRush for some days will experience slower refresh times initially.

** Weight & Dims on eBay: A small minority of transactions on eBay contain data for weight and dims.

*** Shipment Carrier & Service: Does this information flow from the ecommerce system down through the My.ShipRush API?

**** Amazon: The Amazon system sets the ship date when it receives the tracking number.

**** Amazon: Note that the Amazon system does not surface orders to sellers for 30 minutes after the order is placed. Additionally, the Amazon system can be slow to assemble the data. During certain peak periods, the delays can run to 2-5 hours due to Amazon data processing times. The 2-3 hours shown includes the 30 minute standard delay.

*** Only if match found: Note that ShipRush always tries to smartly match the ecommerce shipping service to the real service. Also note that some ecommerce systems allow Web store administrators to rename standard shipping services. For example the shipping services may show in the shopping cart "Standard" shipping and "Fast" shipping but want to actually use "FedEx Ground" service and "2 Day Express." After that My.ShipRush will not be able to match shipping services on orders where "Slow" or "Fast" is set. My.ShipRush will not generate errors and will keep importing orders. Note that the user can edit the My.ShipRush Web store and set up a custom mapping of "Standard" to "FedEx Ground" and other mappings. Also note that the raw shipping service value is available via XML element Shipment.ServiceTypeAsString and you can do mapping yourself.

****** This information is provided to help the developer understand that there may be data in the ecommerce system that is not in My.ShipRush. The missing data is data that predates when the Web store was created in My.ShipRush. This relates to using the ModifiedFrom input parameter on the GetShipments() call: Older data may be in the ecommerce system and may be in the ModifiedFrom/ModifiedTo range requested on GetShipments() but may not be returned by GetShipments() if it predates the creation of this specific Web store in My.ShipRush.


FAQ

Q: What Do I Do with the Shipping Rate?

A: There are two places the shipping costs appears in the API.

There are two places that a "shipping cost" surfaces in My.ShipRush:

  • When the shipment has been made (label printed), and a track # is sent to My.SR via UpdateShipment(), the shipment cost can be passed to UpdateShipment(). This will flow to some ecommerce systems (to those that have a place to save a shipment cost, that is). You can see this as an input param to UpdateShipment().

  • In the <ShippingChargesPaid> element of GetShipments() (and of course in the push payload). This is from the ecommerce system and reflects how much the buyer paid at checkout for shipping during checkout.

Back to Top

Back to top