Reference data

List scopes

GET

List the Store API scopes apps can currently request.

Returns the complete requestable scope catalog grouped by category. Use it to choose app permissions or explain what each permission allows. During installation, merchants see the permissions requested by your app as localized, resource-level entries; related read and write access may be presented together.

This endpoint is public — no token required.

curl https://api-store.tringify.com/api/2025-01/scopes

const res = await fetch("https://api-store.tringify.com/api/2025-01/scopes");
const data = await res.json();

import requests

res = requests.get("https://api-store.tringify.com/api/2025-01/scopes")
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "scopes": [
      {
        "category":"Products",
        "description":"Products, categories, attributes, tags, vendors, and brands",
        "sort_order":5,
        "scopes":[
          {"name":"read_products","label":"Read","resource_label":"Products","description":"View products, categories, attributes, tags, vendors, and brands","category":"Products","sort_order":1},
          {"name":"write_products","label":"Write","resource_label":"Products","description":"Manage products, categories, attributes, tags, vendors, and brands","category":"Products","implies":["read_products"],"sort_order":2}
        ]
      }
    ]
  }
}

List countries

GET

List the countries and regions recognized by the Store API, sorted by name.

Each entry includes a two-letter Tringify country code, a three-letter code, name, capital, primary currency, recommended default locale, calling codes, and postal-code metadata. Most country codes follow current ISO 3166-1 values; a small number are retained for compatibility. Treat each returned code as an opaque identifier. Inclusion in this catalog does not by itself indicate selling, shipping, or payment availability.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
The Authorization header is missing.
401 INVALID_TOKEN
The Bearer header or token prefix is malformed.
401 STORE_ADMIN_TOKEN_RUNTIME_UNAUTHORIZED
The token is expired, revoked, or no longer valid.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 API_VERSION_UNSUPPORTED
The credential is pinned to an API version that cannot be served.
429 RATE_LIMITED
The request allowance is exhausted. Wait for Retry-After before retrying.

curl https://api-store.tringify.com/api/2025-01/reference/countries \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reference/countries", {
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reference/countries",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "countries": [
      {
        "code": "US",
        "alpha3": "USA",
        "name": "United States",
        "capital": "Washington",
        "currency": "USD",
        "default_locale": "en",
        "phone_codes": ["+1"],
        "has_postal_code": true,
        "postal_code_format": "12345"
      },
      {
        "code": "IN",
        "alpha3": "IND",
        "name": "India",
        "capital": "New Delhi",
        "currency": "INR",
        "default_locale": "en",
        "phone_codes": ["+91"],
        "has_postal_code": true,
        "postal_code_format": "110001"
      }
    ]
  }
}

List the subdivisions available for a country or region.

GET

List the subdivisions available for a country or region.

Returns Tringify subdivision identifiers and names for one country or region. Identifiers such as US-California are stable reference values, not ISO 3166-2 abbreviations. Some entries include an optional gst_code, including Indian states and union territories. A recognized country with no subdivision data returns an empty array.

Path parameters

Name	Type	Description
`countryCode` required	`string`	Two-letter country or region code returned by `GET /api/2025-01/reference/countries`. Case-insensitive. Example: `US`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 INVALID_INPUT
countryCode is not a recognized two-letter country or region code.
401 UNAUTHORIZED
The Authorization header is missing.
401 INVALID_TOKEN
The Bearer header or token prefix is malformed.
401 STORE_ADMIN_TOKEN_RUNTIME_UNAUTHORIZED
The token is expired, revoked, or no longer valid.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 API_VERSION_UNSUPPORTED
The credential is pinned to an API version that cannot be served.
429 RATE_LIMITED
The request allowance is exhausted. Wait for Retry-After before retrying.

curl https://api-store.tringify.com/api/2025-01/reference/subdivisions/US \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reference/subdivisions/US", {
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reference/subdivisions/US",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "subdivisions": [
      {"code":"US-California","name":"California","country_code":"US"},
      {"code":"US-New York","name":"New York","country_code":"US"},
      {"code":"US-Texas","name":"Texas","country_code":"US"}
    ]
  }
}

List languages

GET

List every language available for storefront translation.

Each entry includes a BCP 47 language code, English name, native name, and rtl flag. Use the flag to lay out Arabic, Hebrew, Persian, Urdu, and other right-to-left languages correctly in locale selectors and translated experiences.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
The Authorization header is missing.
401 INVALID_TOKEN
The Bearer header or token prefix is malformed.
401 STORE_ADMIN_TOKEN_RUNTIME_UNAUTHORIZED
The token is expired, revoked, or no longer valid.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 API_VERSION_UNSUPPORTED
The credential is pinned to an API version that cannot be served.
429 RATE_LIMITED
The request allowance is exhausted. Wait for Retry-After before retrying.

curl https://api-store.tringify.com/api/2025-01/reference/languages \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reference/languages", {
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reference/languages",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "languages": [
      { "code": "en",    "name": "English",              "native_name": "English",              "rtl": false },
      { "code": "es",    "name": "Spanish",              "native_name": "Español",              "rtl": false },
      { "code": "ar",    "name": "Arabic",               "native_name": "العربية",                "rtl": true  },
      { "code": "pt-BR", "name": "Portuguese (Brazil)",  "native_name": "Português (Brasil)",  "rtl": false },
      { "code": "zh-TW", "name": "Chinese (Traditional)","native_name": "繁體中文",              "rtl": false }
    ]
  }
}

List timezones

GET

List the timezone identifiers accepted by Tringify.

Returns a sorted array of supported timezone identifiers. The list includes IANA timezone names such as America/Los_Angeles, Asia/Kolkata, and Europe/London, plus UTC and supported legacy aliases. Use the returned strings as opaque values in timezone selectors and API requests.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
The Authorization header is missing.
401 INVALID_TOKEN
The Bearer header or token prefix is malformed.
401 STORE_ADMIN_TOKEN_RUNTIME_UNAUTHORIZED
The token is expired, revoked, or no longer valid.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 API_VERSION_UNSUPPORTED
The credential is pinned to an API version that cannot be served.
429 RATE_LIMITED
The request allowance is exhausted. Wait for Retry-After before retrying.

curl https://api-store.tringify.com/api/2025-01/reference/timezones \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reference/timezones", {
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reference/timezones",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "timezones": [
      "Africa/Cairo",
      "America/Los_Angeles",
      "America/New_York",
      "Asia/Kolkata",
      "Asia/Tokyo",
      "Europe/London",
      "UTC"
    ]
  }
}

List every currency code accepted by the Store API.

GET

List every currency code accepted by the Store API.

Returns each supported currency's ISO 4217 code, English name, display symbol, and decimal precision. Symbols are for display and may be shared by several currencies, so use code as the currency identifier. The dataset is the same for every store.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
The Authorization header is missing.
401 INVALID_TOKEN
The Bearer header or token prefix is malformed.
401 STORE_ADMIN_TOKEN_RUNTIME_UNAUTHORIZED
The token is expired, revoked, or no longer valid.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 API_VERSION_UNSUPPORTED
The credential is pinned to an API version that cannot be served.
429 RATE_LIMITED
The request allowance is exhausted. Wait for Retry-After before retrying.

curl https://api-store.tringify.com/api/2025-01/reference/currencies \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reference/currencies", {
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reference/currencies",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "currencies": [
      {"code":"AUD","name":"Australian Dollar","symbol":"$","decimals":2},
      {"code":"JPY","name":"Yen","symbol":"¥","decimals":0},
      {"code":"USD","name":"US Dollar","symbol":"$","decimals":2}
    ]
  }
}

List phone codes

GET

List supported calling regions, dial codes, examples, and flags.

Returns calling regions with country_code, country_name, dial_code, integer dial_code_numeric, example_number, and flag. Each entry also includes possible_lengths (an array of integers), integer min_national_digits and max_national_digits, and national_prefix (a string, empty when no removable prefix applies). Use the complete allowed-length list rather than treating every length between its bounds as valid. See Phone numbers and country codes for the validation rules and examples.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
The Authorization header is missing.
401 INVALID_TOKEN
The Bearer header or token prefix is malformed.
401 STORE_ADMIN_TOKEN_RUNTIME_UNAUTHORIZED
The token is expired, revoked, or no longer valid.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 API_VERSION_UNSUPPORTED
The credential is pinned to an API version that cannot be served.
429 RATE_LIMITED
The request allowance is exhausted. Wait for Retry-After before retrying.

curl https://api-store.tringify.com/api/2025-01/reference/phone-codes \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reference/phone-codes", {
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reference/phone-codes",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "phone_codes": [
      {
        "possible_lengths": [
          10
        ],
        "min_national_digits": 10,
        "max_national_digits": 10,
        "national_prefix": "0",
        "country_code": "IN",
        "country_name": "India",
        "dial_code": "+91",
        "dial_code_numeric": 91,
        "example_number": "074104 10123",
        "flag": "🇮🇳"
      },
      {
        "possible_lengths": [
          10
        ],
        "min_national_digits": 10,
        "max_national_digits": 10,
        "national_prefix": "1",
        "country_code": "US",
        "country_name": "United States",
        "dial_code": "+1",
        "dial_code_numeric": 1,
        "example_number": "(201) 555-0123",
        "flag": "🇺🇸"
      }
    ]
  },
  "success": true
}

Get number format defaults

GET

Get number and currency-display defaults for a country or region.

Returns decimal and thousands separators, currency-symbol placement and spacing, and digit grouping. grouping_pattern is "3" for standard thousands grouping and "3,2" for Indian lakh and crore grouping. The country or region code is case-insensitive.

Path parameters

Name	Type	Description
`countryCode` required	`string`	Two-letter country or region code returned by `GET /api/2025-01/reference/countries`. Case-insensitive. Example: `DE`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 INVALID_INPUT
countryCode is not a recognized two-letter country or region code.
401 UNAUTHORIZED
The Authorization header is missing.
401 INVALID_TOKEN
The Bearer header or token prefix is malformed.
401 STORE_ADMIN_TOKEN_RUNTIME_UNAUTHORIZED
The token is expired, revoked, or no longer valid.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 API_VERSION_UNSUPPORTED
The credential is pinned to an API version that cannot be served.
429 RATE_LIMITED
The request allowance is exhausted. Wait for Retry-After before retrying.

curl https://api-store.tringify.com/api/2025-01/reference/number-format-defaults/DE \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reference/number-format-defaults/DE", {
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reference/number-format-defaults/DE",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "decimal_separator": ",",
    "thousands_separator": ".",
    "grouping_pattern": "3",
    "currency_symbol_position": "after",
    "currency_symbol_spacing": true
  }
}

List address formats

GET

List address formats for all supported countries and regions.

Retrieve the current address formats for every supported country with GET /api/2025-01/reference/address-format, or one country with GET /api/2025-01/reference/address-format/{countryCode}. The collection response is data.address_formats; a single-country response is data. Each record includes field labels, required, zip_regex, zip_example, subdivisions, and updated_at (RFC 3339 UTC). Use the exact subdivisions[].code in address province_code or location state_province. Codes may be full names, abbreviations, or non-Latin text: India uses Uttar Pradesh, the US uses NY, Canada uses ON, Australia uses NSW, and Japan may return 東京都. Show name or latin_name as the label. Do not assume ISO 3166-2 codes: UP and IN-UP are not substitutes for the Indian address-format value Uttar Pradesh. Tax and shipping zone subdivision identifiers belong to their own catalog. The required string uses A=address, C=city, S=state, Z=postal code, N=name, O=organization; resource-specific endpoint requirements also apply. A customer address requires first_name, last_name, address1, city and country_code, while province_code and postal_code are optional but validated when supplied. An online-fulfilling location additionally requires its country-dependent subdivision and postal fields. With no subdivision list, a supplied state/province is free text subject to the resource limits. Validate supplied postal values against zip_regex and show zip_example. India additionally checks that a PIN exists and belongs to the supplied state. A format match does not verify deliverability. Supplied address phones are validated for the address country and normalized to E.164; phone-region examples are available from /reference/phone-codes. Refresh cached metadata instead of maintaining guessed country rules.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
The Authorization header is missing.
401 INVALID_TOKEN
The Bearer header or token prefix is malformed.
401 STORE_ADMIN_TOKEN_RUNTIME_UNAUTHORIZED
The token is expired, revoked, or no longer valid.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 API_VERSION_UNSUPPORTED
The credential is pinned to an API version that cannot be served.
429 RATE_LIMITED
The request allowance is exhausted. Wait for Retry-After before retrying.

curl https://api-store.tringify.com/api/2025-01/reference/address-format \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reference/address-format", {
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reference/address-format",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "address_formats": [
      {
        "country_code":"US",
        "format":"%N%n%O%n%A%n%C, %S %Z",
        "required":"ACSZ",
        "upper_fields":"CS",
        "state_label":"state",
        "zip_label":"zip",
        "city_label":"city",
        "labels":{"state":"State","zip":"ZIP code","city":"City"},
        "zip_regex":"(\\d{5})(?:[ \\-](\\d{4}))?",
        "zip_example":"95014,22162-1010",
        "subdivisions":[{"code":"CA","name":"California"}],
        "updated_at":"2026-07-01T00:00:00Z"
      }
    ]
  }
}

Get an address format

GET

Get the address format for one country or region.

Retrieve the current address formats for every supported country with GET /api/2025-01/reference/address-format, or one country with GET /api/2025-01/reference/address-format/{countryCode}. The collection response is data.address_formats; a single-country response is data. Each record includes field labels, required, zip_regex, zip_example, subdivisions, and updated_at (RFC 3339 UTC). Use the exact subdivisions[].code in address province_code or location state_province. Codes may be full names, abbreviations, or non-Latin text: India uses Uttar Pradesh, the US uses NY, Canada uses ON, Australia uses NSW, and Japan may return 東京都. Show name or latin_name as the label. Do not assume ISO 3166-2 codes: UP and IN-UP are not substitutes for the Indian address-format value Uttar Pradesh. Tax and shipping zone subdivision identifiers belong to their own catalog. The required string uses A=address, C=city, S=state, Z=postal code, N=name, O=organization; resource-specific endpoint requirements also apply. A customer address requires first_name, last_name, address1, city and country_code, while province_code and postal_code are optional but validated when supplied. An online-fulfilling location additionally requires its country-dependent subdivision and postal fields. With no subdivision list, a supplied state/province is free text subject to the resource limits. Validate supplied postal values against zip_regex and show zip_example. India additionally checks that a PIN exists and belongs to the supplied state. A format match does not verify deliverability. Supplied address phones are validated for the address country and normalized to E.164; phone-region examples are available from /reference/phone-codes. Refresh cached metadata instead of maintaining guessed country rules.

Path parameters

Name	Type	Description
`countryCode` required	`string`	Two-letter country or region code returned by `GET /api/2025-01/reference/countries`. Case-insensitive. Example: `JP`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 INVALID_INPUT
countryCode is not a recognized two-letter country or region code.
404 NOT_FOUND
No address format is available for this country or region code.
401 UNAUTHORIZED
The Authorization header is missing.
401 INVALID_TOKEN
The Bearer header or token prefix is malformed.
401 STORE_ADMIN_TOKEN_RUNTIME_UNAUTHORIZED
The token is expired, revoked, or no longer valid.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 API_VERSION_UNSUPPORTED
The credential is pinned to an API version that cannot be served.
429 RATE_LIMITED
The request allowance is exhausted. Wait for Retry-After before retrying.

curl https://api-store.tringify.com/api/2025-01/reference/address-format/JP \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reference/address-format/JP", {
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reference/address-format/JP",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "success": true,
  "data": {
    "country_code":"JP",
    "format":"〒%Z%n%S%n%A%n%O%n%N",
    "required":"ASZ",
    "upper_fields":"S",
    "state_label":"prefecture",
    "zip_label":"postal",
    "city_label":"city",
    "labels":{"state":"Prefecture","zip":"Postal code","city":"City"},
    "zip_regex":"\\d{3}-?\\d{4}",
    "zip_example":"154-0023,350-1106,951-8073,112-0001,208-0032,231-0012",
    "subdivisions":[{"code":"東京都","name":"東京都","latin_name":"Tokyo"}],
    "updated_at":"2026-07-01T00:00:00Z"
  }
}