Store

The Store Object

A Rutter Store represents information about the merchant's store, including a consumer-identifiable name, URL, and default currency.

Properties

idstring

The Rutter generated unique ID of the store.

platform_idstringOptional

The platform's unique identifier for the store. Supported for Amazon and Shopify.

store_namestring

The unique identifier or brand name of the store.

urlstring

The consumer facing URL of the store.

default_currencystringnullable

The ISO 4217 currency code of the store.

emailstringOptional

The email of the primary contact of the store.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/store

Fetch a Store

GEThttps://production.rutterapi.com/versioned/store

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

200

Example Response Body

JSON

1{
2  "store": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "store_name": "The Rutter Store",
5    "url": "https://www.rutter.com",
6    "default_currency": "USD",
7    "email": "eric@rutter.com",
8    "platform_data": {
9      "id": 123,
10      "data": "Varies by platform"
11    }
12  },
13  "connection": {
14    "id": "00000000-0000-0000-0000-000000000000",
15    "orgId": "00000000-0000-0000-0000-000000000000",
16    "platform": "SHOPIFY"
17  }
18}

Have questions?

Contact support for personalized guidance.

Contact support