⚠️ ShipStation API V2 Is Now Available ⚠️

Use the content on this site if you need API V1 documentation only.

If you need documentation about the V2 endpoints available with ShipStation's Shipping API or Inventory API add-ons, go to our V2 API developer portal at https://docs.shipstation.com/.

Get Store Refresh status

Retrieves the refresh status of a given store.

Requirements:

  • You'll need a storeId to make this API call.
  • To find the storeId for a specific store and also to see the list of stores installed in your account, make a List Stores call.
Name Data Type Description
storeId number Specifies the store whose status will be retrieved.

Required

Example Request

GET /stores/getrefreshstatus?storeId=storeId HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__

Example Response

{
  "storeId": 12345,
  "refreshStatusId": 2,
  "refreshStatus": "Updating orders",
  "lastRefreshAttempt": "8-13-2014",
  "refreshDate": "8-13-2014"
}