Commerce

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.

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.

Example Store Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "store_name": "The Rutter Store",
  "url": "https://www.rutter.com",
  "default_currency": "USD",
  "email": "eric@rutter.com"
}

Fetch a Store

GET /store
Supported for: AmazonBig CommerceeBayEtsyLazadaMagentoMercado LibrePrestashopShopifyShoplazzaShoplineSquareSquarespaceStripeWalmartWixWoo Commerce

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    expandenumoptionalquery

    Optionally, include raw external platform data when fetching data.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    connectionobjectoptional
    Show connection attributes
    storenullable
    Show store attributes
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "SHOPIFY"
  },
  "store": {
    "id": "00000000-0000-0000-0000-000000000000",
    "store_name": "The Rutter Store",
    "url": "https://www.rutter.com",
    "default_currency": "USD",
    "email": "eric@rutter.com"
  }
}
Previous
Tokens