Core Resources

Store

The store endpoint includes ReCharge settings and other store specific information.

6 additions in V2, marked New

Everything marked New also works when you send X-Recharge-Version: 2021-11.

Endpoints

GET/store

#The store object

The store endpoint includes Recharge settings and other store specific information.

Attributes

idinteger
Unique number identifier of the store.
allow_customers_to_skip_deliveryintegerNew
Whether customers are allowed to skip a delivery in the customer portal (1) or not (0).
checkout_logo_urlstring
Checkout logo url.
checkout_platformstring
Checkout platform.
Possible values
rechargeshopify
external_platform_domainstring · nullableNew
Domain of the store on the external platform.
platform_domainstring · nullableNew
The store's domain as registered with Recharge.
storefront_domainstring · nullableNew
Domain of the store's storefront.
subscriptions_enabledbooleanNew
Whether subscriptions are enabled for the store.
test_modebooleanNew
Whether the store is in test mode. Currently always returned as false by this endpoint.
created_atdatetime
Date and time when the store is created.
currencystring
Currency of the store.
Related guides: Supported currencies
customer_portal_base_urlstring
Customer Portal Base URL.
default_api_versionstring
Default API version.
emailstring
E-mail address of the store owner.
enabled_presentment_currenciesarray
Enabled currencies the store sells in.
enabled_presentment_currencies_symbolsarray of objects
Currency symbol used for enabled currencies the store sells in.
Show child attributesHide child attributes4
- currencystring
  Currency used.
- locationstring
  Describes if the symbol appears before or after currency.
- suffixstring
  Suffix appended to symbol.
- symbolstring
  The symbol of the currency.
disabled_currencies_historicalarray
A ledger of currencies that the store no longer sells in. If a currency is present in both the enabled_presentment_currencies and disabled_currencies_historical ledger it is because it was disabled at one point in time but is now enabled.
external_platformstring
External platform connected to Recharge.
Possible values
big_commerceheadlessmagentoshopify
Will be one of shopify, big_commerce, headless, or magento
identifierstring
Unique identifier of the store on the external platform.
merchant_portal_base_urlstring
Merchant portal base URL.
namestring
Name of the store.
phonestring
Phone number of the store owner.
timezoneobject
Timezone of the store.
Show child attributesHide child attributes2
- iana_namestring
  Iana database timezone format.
- namestring
  Timezone for the Store
updated_atdatetime
The date and time when the address was last updated.
weight_unitstring
Weight unit for the store.

The store object

{
  "store": {
    "id": 89559201,
    "allow_customers_to_skip_delivery": 1,
    "checkout_logo_url": null,
    "checkout_platform": "recharge",
    "created_at": "2020-07-15T00:00:00+00:00",
    "currency": "USD",
    "customer_portal_base_url": null,
    "default_api_version": "2021-01",
    "email": "email@email.com",
    "external_platform": "shopify",
    "external_platform_domain": "store-id.myshopify.com",
    "identifier": "store-id",
    "merchant_portal_base_url": null,
    "name": "store-name",
    "phone": "5555555555",
    "enabled_presentment_currencies": [
      "USD"
    ],
    "enabled_presentment_currencies_symbols": [
      {
        "currency": "USD",
        "location": "before",
        "suffix": "",
        "symbol": "$"
      }
    ],
    "disabled_currencies_historical": [],
    "platform_domain": "store-id.myshopify.com",
    "storefront_domain": "shop.store-name.com",
    "subscriptions_enabled": true,
    "test_mode": false,
    "timezone": {
      "iana_name": "America/New_York",
      "name": "(GMT-05:00) Eastern Time (US & Canada)"
    },
    "updated_at": "2020-07-15T00:00:00+00:00",
    "weight_unit": "g"
  }
}

#Retrieve a store

GET/store

Retrieve store details.

Scopesread_storestore_info

Either the read_store or the store_info scope is sufficient.

GET/store

curl 'https://api.rechargeapps.com/store' \
  -H 'X-Recharge-Version: v2' \
  -H 'X-Recharge-Access-Token: your_api_token'

Response

{
  "store": {
    "id": 4797,
    "allow_customers_to_skip_delivery": 1,
    "checkout_logo_url": null,
    "checkout_platform": "recharge",
    "created_at": "2020-04-22T00:20:52+00:00",
    "currency": "USD",
    "customer_portal_base_url": null,
    "default_api_version": "2021-01",
    "email": "email@email.com",
    "enabled_presentment_currencies": [
      "USD"
    ],
    "enabled_presentment_currencies_symbols": [
      {
        "currency": "USD",
        "location": "before",
        "suffix": "",
        "symbol": "$"
      }
    ],
    "disabled_currencies_historical": [],
    "external_platform": "custom",
    "external_platform_domain": "store-id.myshopify.com",
    "identifier": "store-id",
    "merchant_portal_base_url": null,
    "name": "store-name",
    "platform_domain": "store-id.myshopify.com",
    "province": "Connecticut",
    "phone": "5555555555",
    "storefront_domain": "shop.store-name.com",
    "subscriptions_enabled": true,
    "test_mode": false,
    "timezone": {
      "iana_name": "America/New_York",
      "name": "(GMT-05:00) Eastern Time (US & Canada)"
    },
    "updated_at": "2020-04-25T00:20:52+00:00",
    "weight_unit": "g"
  }
}