Connect Frate Returns to Rig

    Frate Returns runs the returns portal for your Shopify store. Rig pulls each return group with its shipments and SKU-level lines, so you can see why products come back and what that costs.

    Before you start

    • You need access to the Frate app with permission to open Settings.
    • Frate shows an API token once, when you create it, so have somewhere safe to paste it.

    Step 1: Create a Frate API token

    1. Sign in to the Frate app and open Settings.
    2. Under API Tokens, generate a new token.
    3. Copy the token straight away. Frate does not show it again, so create a new one if you lose it.

    Step 2: Connect it in Rig

    Adding a source needs a workspace owner, or a role with the Manage connections permission, on a workspace where you manage your own connections. If the Connectors tab says “Data ingestion for this workspace is managed by Rig”, ask an owner or Rig support to add the source.

    1. In Rig, open Connections, choose the Connectors tab and go to Sources & actions.
    2. Search for Frate Returns, open the card and click Connect.
    3. Frate API token: Paste the token you created.
    4. Click Continue. Rig checks the credentials and lists the streams it can reach, so choose the ones you want and click Connect.
    5. The source then syncs on its schedule, which is nightly unless you change it. To load data straight away, click Sync on its row; Test pulls a small sample first if you want to check the connection.

    What Rig pulls in

    Frate Returns lands in its own frate_returns schema in your warehouse:

    • Return groups: each return with its order, customer, status and timestamps. Shipments (carrier, tracking, addresses, shipped and delivered dates) and SKU-level return lines (with the return-reason taxonomy and amounts) arrive as linked child tables such as return_groups__shipments and return_groups__returns.
    • Allowlist items: the policy exceptions you have set up in Frate.

    Frate reports return amounts in GBP.

    Good to know

    • Frate's return-groups endpoint is slow, about 18 seconds for a page of 50, so a first sync on a store with a long return history can take several hours. Rig works through it in date windows and saves progress after each, so an interrupted sync carries on from where it stopped.
    • A return can change weeks after it was created, when it ships, arrives or is refunded. Each later sync picks up every return updated since the last one and merges it in.
    • Frate authenticates with a token in the X-Frate-Api-Token header, so there is no OAuth step.
    • To disconnect Frate Returns, click the bin icon on the source's row under Sources & actions. Only whoever connected the source or a workspace owner can do this, and data already synced stays in the warehouse.

    What people use this for

    • Find the products returns are eating
    • Act on return reasons
    • Understand what returns cost

    More ideas for using Frate Returns

    Frate Returns documentation

    Was this guide helpful?