Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ocular.dev/llms.txt

Use this file to discover all available pages before exploring further.

Ocular connects to Return Prime using a single credential — an App Access Token generated from a custom app inside Return Prime.

What you need

An App Access Token from a Return Prime custom app.

What it unlocks

Return-reason breakdown in Quickstart Reports → Sales, returns-by-SKU analysis, and refund attribution in the P&L.
Return Prime connector placeholder

​
Step 1 · Generate an App Access Token in Return Prime

Open Return Prime

Log in to your Return Prime dashboard.

Open Settings

Navigate to Settings at the bottom of the left sidebar.

Develop apps

Go to the Integrations section and click Develop apps.

Create new app

Click Create new app, name it (e.g., Ocular Analytics), and click Create app.

Open API credentials

Navigate to the API credentials tab on the new app.

Copy the Access Token

Copy the Access Token shown on that page.
Save this token securely. You may only be able to view it once. If you lose the token, you’ll need to regenerate it from the custom app’s API credentials tab — all previous tokens are invalidated when you do.

​
Step 2 · Plug the credentials into Ocular

Open the connector form

In Ocular, navigate to Data Management → Connectors → Add connector → Return Prime.

Fill the fields

Connector Name

Free-form label.

Connector Identifier

Auto-generated.

Start Date

YYYY-MM-DD — how far back Ocular pulls return and exchange data.

Lookback Days

Default 30 days of past data refreshed on every sync.

Schedule Frequency

Numeric value + unit (e.g., 4 hours).

Auto Sync

Toggle on to start sync immediately when the connector is enabled.

App Access Token

The token from Step 1.

Create the connector

Click Create Connector. Ocular stores the token in its encrypted vault and triggers the first sync.

​
Troubleshooting

Re-copy the token — watch for leading/trailing spaces. If the issue persists, regenerate the token from the custom app’s API credentials tab (this invalidates all previous tokens).
Open the custom app in Return Prime, go to API credentials, and click regenerate. Paste the new token into the Ocular connector form and re-save.
Increase Lookback Days — returns are often initiated weeks after the original purchase, especially during sale windows. 60–90 days is common for brands with long return policies.
For ticket-writing format when filing a connector issue, see Working with the Ocular team → Connector-not-working tickets.