The /status
endpoint allows developers to fetch general information about a merchant's store and its synchronization process.
Response Properties
Property | Type | Description |
---|---|---|
platform | string | The ENUM of its platform based on Supported Commerce Platforms |
needs_update_status | object | Contains bool |
disabled_status | object | Contains information regarding if or why a connection is disabled. |
historical_sync_status | object | Contains progress information on initial sync and historical sync based on Connection Lifecycle |
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 lastest ISO 8601 timestamp that Rutter successfully sync'ed with platform. If you see this is |
Status explanations
Needs Update Status:
needs_update
: if it is 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 merchantlink_url
(included in the response) to the merchant for reauthentication.
Historical Sync Status:
historical_sync_completed
: If it is true, it means we have completed syncing all historical data and we are in Ongoing Data Synchronization phase based on Connection Lifecyclenum_batches_completed
: If you have Configuring a Speedup set up, this number indicates the number of batches that we have finished sync data.synced_orders_count
: How many orders we have sync'ed so farsynced_transaction_count
: How many transactions we have sync'ed so farsynced_balance_sheets_count
: (for accounting) How many balance sheets we have sync'ed so farsynced_cash_flows_count
: (for accounting) How many cash flow statements we have sync'ed so farsynced_income_statements_count
: (for accounting) How many income statements we have sync'ed so farestimated_completed_at
: Timestamp we estimated when we complete all historical data sync
Disabled Status:
is_disabled
: if it is true, this could be connectivity issues on our side to their store (e.g. WooCommerce store goes offline or Shopify store didn’t pay the due). This usually requires the merchant to take additional steps other than simply re-authenticate with Rutter.disabled_reason
: We also provide a standardized enumeration for why a connection is disabled below and its possible values. The disabled reason would benull
ifis_disabled
is false.
Disabled Reason ENUM
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 | Shop id is invalid. Please check if 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 | Shop has been disabled on platform. Please check with merchant if shop needs to be reenabled. |
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 unavailable shop. Please check if 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 expired SSL Certificate. Please ask merchant to renew. |
UNKNOWN | Unable to establish connection with store. |