Sandbox Overview

Test the Rutter API

What is Rutter Sandbox?

Rutter Sandbox is an environment that enables developers to test the Rutter API with realistic data without needing to authenticate merchants via Rutter Link. With Rutter Sandbox, you can confirm that your integration works the way you intend.

Testing Rutter Link

In the sandbox, you can test Rutter Link without needing to authenticate a real store. This makes it easy to integrate Rutter Link into your application and test the end user connection experience. You'll need the sandbox public key, which you can find on your Rutter Dashboard. For more on how to connect a store, read Rutter Link Sandbox.

Testing Rutter API

We also provide you with an existing set of active connections so you can quickly test the Rutter API. You can find the sandbox access tokens in your Rutter Dashboard:

With this access token, you can fetch information from a sandbox Shopify store and get realistic data. Just make sure to change the base URL of your requests from https://production.rutterapi.com to https://sandbox.rutterapi.com!

You are also free to use any Shopify access token to send requests to the Sandbox. In the future, we will be adding more platforms to the sandbox environment.

Supported Endpoints

📘

Note

We've provided an example for Fetch All Orders with Rutter Sandbox. To use the other routes listed below, go to the corresponding API page in our standard API docs, and simply change the subdomain of your request URL from production to sandbox.

At the moment, we support the following endpoints in sandbox mode:

  • Fetch All orders (GET /order)
  • Fetch an Order (GET /order/{id})
  • Fetch All Products (GET /products)
  • Fetch a Product (GET /products/{id})
  • Fetch All Customers (GET /customers)
  • Fetch a Customer (GET /customers/{id})
  • Fetch All Transactions (GET /transactions)
  • Fetch All Payouts (GET /payouts)