Fetch a Connection Status

The /status endpoint allows developers to fetch connection level information to better understand health and data synchronization progress.

Response Properties


PropertyTypeDescription
statusobjectObject containing the connection status
platformstringThe ENUM of its platform based on the supported platforms listed in the Commerce Platforms or Accounting Platforms pages.
needs_update_statusobjectContains information regarding if a connection needs an update. See needs_update_status table below for more information.
disabled_statusobjectContains information regarding if a connection is disabled and why. See disabled_status table below for more information.
historical_sync_statusobjectContains progress information on initial sync and historical sync based on the Connection Lifecycle. See historical_sync_status table below for more information.
is_readybooleanWhether the connection is ready to receive requests
link_urlstringThe URL that can be shared with merchant to have them re-authenticate
created_atstringThe ISO 8601 timestamp the connection is established
last_sync_completed_atstring | nullThe 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


PropertyTypeDescription
needs_updatebooleanIf 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


PropertyTypeDefinition
is_disabledbooleanIf 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_reasonstringSee Disabled Reason Enumeration table below for the possible reasons. The disabled reason would be null if is_disabled is false.

Disabled Reason Enumeration


EnumerationExplanation
SHOP_API_KEY_EXPIREDAPI key for the shop has expired. The merchant needs to get a new API key
SHOP_ID_IS_INVALIDThe shop ID is invalid. Please check if the shop id in your records is correct
SHOP_NOT_FOUNDShop cannot be found. Please check with merchant if shop url is correct
SHOP_IS_DISABLED_OR_EXPIREDThe shop has been disabled on the platform. Please check with merchant if the shop needs to be re-enabled
SHOP_IS_LOCKEDPlatform has locked the shop. Please ask merchant to reach out to merchant to determine action needed to unlock store
SHOP_PAYMENT_REQUIREDPayment required. Please ask merchant to make payment to platform
SHOP_IS_UNAVAILABLEConnection attempted to be made with the unavailable shop. Please check if the shop is ready
WEB_SERVICE_IS_DISABLEDWeb service has been disabled
TUNNEL_ERRORConnection is made with developer account. Please use production credentials to access instead
CERT_EXPIREDConnection cannot be made due to an expired SSL Certificate. Please ask the merchant to renew
UNKNOWNUnable to establish a Connection with the store

Historical Sync Status Object


PropertyTypeDescription
historical_sync_completedbooleanIf true, it means we have completed syncing all historical data and we are in Ongoing Data Synchronization phase based on Connection Lifecycle.
num_batches_completedintegerIf you have Configuring a Speedup set up, this number indicates the number of batches that we have finished sync data.
synced_orders_countintegerHow many orders we have sync'ed so far
synced_transaction_countintegerHow many transactions we have sync'ed so far
synced_balance_sheets_countinteger(For accounting) How many balance sheets we have sync'ed so far
synced_cash_flows_countinteger(For accounting) How many cash flow statements we have sync'ed so far
synced_income_statements_countinteger(For accounting) How many income statements we have sync'ed so far
batchesobject[]Sync status for each batch of data from Rutter
totalobjectObject 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.

PropertyTypeDescription
batch_numintegerThe index representing the current batch.
configobjectWhen 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_infoobjectIndicates 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, or fulfillments

Config Object


PropertyTypeDescription
timeFrameInMonthsintegerIndicates how many months back to fetch data.
orderDataFetchConfigbooleanIf true, then order data will be fetched.
If false, then the batch will fetch all historic data across all entity types.
storeDataFetchConfigbooleanIf true, then store data will be fetched.
If false, then the batch will fetch all historic data across all entity types.
payoutsDataFetchConfigbooleanIf true, then payouts data will be fetched.
If false, then the batch will fetch all historic data across all entity types.
productsDataFetchConfigbooleanIf true, then products data will be fetched.
If false, then the batch will fetch all historic data across all entity types.
customerDataFetchConfigbooleanIf true, then customer data will be fetched.
If false, then the batch will fetch all historic data across all entity types.
transactionsDataFetchConfigbooleanIf true, then transactions data will be fetched.
If false, then the batch will fetch all historic data across all entity types.
fulfillmentsDataFetchConfigbooleanIf true, then fulfillments data will be fetched.
If false, then the batch will fetch all historic data across all entity types.

Progress Info Object


PropertyTypeDescription
entityobjectCan be orders, transactions, or products. See the example response for more information.
statusstringCan be COMPLETED or IN_PROGRESS. Indicates the progress status of the data sync.
oldest_batch_entity_datestringThe ISO 8601 timestamp of the oldest possible entity that can be fetched from a platform for the batch
newest_batch_entity_datestringThe 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

PropertyTypeDescription
oldest_entity_datestringThe ISO 8601 timestamp representing the oldest platform date fetched.
newest_entity_datestringThe ISO 8601 timestamp representing the newest platform date fetched.
readybooleanTrue if the syncing for a particular entity has finished.
synced_countintegerTotal number of synced entities for a particular entity.
Language
Authentication
Basic
base64
: