get https://production.rutterapi.com/connections/status
The /status endpoint allows developers to fetch connection level information to better understand health and data synchronization progress.
Response Properties
| Property | Type | Description |
|---|---|---|
| status | object | Object containing the connection status |
| platform | string | The ENUM of its platform based on the supported platforms listed in the Commerce Platforms or Accounting Platforms pages. |
| needs_update_status | object | Contains information regarding if a connection needs an update. See needs_update_status table below for more information. |
| disabled_status | object | Contains information regarding if a connection is disabled and why. See disabled_status table below for more information. |
| historical_sync_status | object | Contains progress information on initial sync and historical sync based on the Connection Lifecycle. See historical_sync_status table below for more information. |
| is_ready | boolean | Whether the connection is ready to receive requests |
| link_url | string | The URL that can be shared with merchant to have them re-authenticate |
| created_at | string | The ISO 8601 timestamp the connection is established |
| last_sync_completed_at | string | null | The latest ISO 8601 timestamp that Rutter successfully sync'ed with platform. If you see this is null, it means Rutter has never successfully made a sync through platform |
Needs Update Status Object
| Property | Type | Description |
|---|---|---|
| needs_update | boolean | If true, it means that the merchant uninstalled the application from their end, revoked the application’s access, platform outage, etc. If you would like to re-establish the connection with this merchant, you need to send the link_url (included in the response) to the merchant for re-authentication. |
Disabled Status Object
| Property | Type | Definition |
|---|---|---|
| is_disabled | boolean | If true, this could be connectivity issues on our side to their store (e.g. WooCommerce store goes offline or Shopify store didn’t pay their dues). This usually requires the merchant to take additional steps other than simply re-authenticate with Rutter. |
| disabled_reason | string | See Disabled Reason Enumeration table below for the possible reasons. The disabled reason would be null if is_disabled is false. |
Disabled Reason Enumeration
| Enumeration | Explanation |
|---|---|
| SHOP_API_KEY_EXPIRED | API key for the shop has expired. The merchant needs to get a new API key |
| SHOP_ID_IS_INVALID | The shop ID is invalid. Please check if the shop id in your records is correct |
| SHOP_NOT_FOUND | Shop cannot be found. Please check with merchant if shop url is correct |
| SHOP_IS_DISABLED_OR_EXPIRED | The shop has been disabled on the platform. Please check with merchant if the shop needs to be re-enabled |
| SHOP_IS_LOCKED | Platform has locked the shop. Please ask merchant to reach out to merchant to determine action needed to unlock store |
| SHOP_PAYMENT_REQUIRED | Payment required. Please ask merchant to make payment to platform |
| SHOP_IS_UNAVAILABLE | Connection attempted to be made with the unavailable shop. Please check if the shop is ready |
| WEB_SERVICE_IS_DISABLED | Web service has been disabled |
| TUNNEL_ERROR | Connection is made with developer account. Please use production credentials to access instead |
| CERT_EXPIRED | Connection cannot be made due to an expired SSL Certificate. Please ask the merchant to renew |
| UNKNOWN | Unable to establish a Connection with the store |
Historical Sync Status Object
| Property | Type | Description |
|---|---|---|
| historical_sync_completed | boolean | If true, it means we have completed syncing all historical data and we are in Ongoing Data Synchronization phase based on Connection Lifecycle. |
| num_batches_completed | integer | If you have Configuring a Speedup set up, this number indicates the number of batches that we have finished sync data. |
| synced_orders_count | integer | How many orders we have sync'ed so far |
| synced_transaction_count | integer | How many transactions we have sync'ed so far |
| synced_balance_sheets_count | integer | (For accounting) How many balance sheets we have sync'ed so far |
| synced_cash_flows_count | integer | (For accounting) How many cash flow statements we have sync'ed so far |
| synced_income_statements_count | integer | (For accounting) How many income statements we have sync'ed so far |
| batches | object[] | Sync status for each batch of data from Rutter |
| total | object | Object containing overall status info and count for each entity across all batches for a connection. |
Batches Object
Data Fetch Speed Up Configured?
If data fetch config is setup, then this field will be an array of batch status objects. Otherwise, this field will only contain one batch that fetches all historic entities for a connection.
| Property | Type | Description |
|---|---|---|
| batch_num | integer | The index representing the current batch. |
| config | object | When data fetch config is set up, this object contains information on how many months back to fetch and which entity type to include in that batch. If there is not configured, then the batch will fetch all historic data across all entity types. See Config Object table below for more information. An entity type can be order, store, payouts, products, customers, transactions, or fulfillments. |
| progress_info | object | Indicates the progress of each entity type that is configured in the config object. |
Entity Type
Entity type can be
order,store,payouts,products,customers,transactions, orfulfillments
Config Object
| Property | Type | Description |
|---|---|---|
| timeFrameInMonths | integer | Indicates how many months back to fetch data. |
| orderDataFetchConfig | boolean | If true, then order data will be fetched.If false, then the batch will fetch all historic data across all entity types. |
| storeDataFetchConfig | boolean | If true, then store data will be fetched.If false, then the batch will fetch all historic data across all entity types. |
| payoutsDataFetchConfig | boolean | If true, then payouts data will be fetched.If false, then the batch will fetch all historic data across all entity types. |
| productsDataFetchConfig | boolean | If true, then products data will be fetched.If false, then the batch will fetch all historic data across all entity types. |
| customerDataFetchConfig | boolean | If true, then customer data will be fetched.If false, then the batch will fetch all historic data across all entity types. |
| transactionsDataFetchConfig | boolean | If true, then transactions data will be fetched.If false, then the batch will fetch all historic data across all entity types. |
| fulfillmentsDataFetchConfig | boolean | If true, then fulfillments data will be fetched.If false, then the batch will fetch all historic data across all entity types. |
Progress Info Object
| Property | Type | Description |
|---|---|---|
| entity | object | Can be orders, transactions, or products. See the example response for more information. |
| status | string | Can be COMPLETED or IN_PROGRESS. Indicates the progress status of the data sync. |
| oldest_batch_entity_date | string | The ISO 8601 timestamp of the oldest possible entity that can be fetched from a platform for the batch |
| newest_batch_entity_date | string | The ISO 8601 timestamp of the latest entity that's been fetched by Rutter in the batch time frame |
Total Object
For each entity, we expose the following information
| Property | Type | Description |
|---|---|---|
| oldest_entity_date | string | The ISO 8601 timestamp representing the oldest platform date fetched. |
| newest_entity_date | string | The ISO 8601 timestamp representing the newest platform date fetched. |
| ready | boolean | True if the syncing for a particular entity has finished. |
| synced_count | integer | Total number of synced entities for a particular entity. |