store

The store behind the key

get/v1/store

Request

  • Base URL
    https://api.octaneai.com
  • Auth
    HTTP bearer

Response

The store behind the key: who it is, its currency and timezone, its plan class, limits, the key's scopes and credit usage.

namestring nullable required

The store's display name, as the dashboard names it

shop_domainstring nullable required

The store's myshopify.com domain; null until its details sync

currencystring nullable required

ISO code of the currency every money amount is in; null until the store's details sync

timezonestring nullable required

IANA name of the store's own timezone, the one to read 'last week' in; null until its details sync. Analytics answer in the tz asked for, UTC by default

plan_classstring required

basic | plus | enterprise | paused; picks the limit table

scopesstring[] required

The scopes this key carries

Changes

No recorded changes to this operation across all 1 revision of this API.