Store

What every other response is read with: the currency of money amounts, the time zone of calendar dates and the languages of the content.

Loading the search index…

Store

Objects

Store

  • idintegerrequired

    ID of the store.

  • namemap of stringrequired

    Name of the store by language.

  • currencystringrequired

    Currency of the store, an ISO 4217 code. Every money amount of the API is an integer in its minor units: cents for USD, ARS or BRL, whole pesos for CLP.

  • timezonestringrequired

    Time zone of the store, an IANA name. Calendar dates of the API, such as reopens_on, are dates in this zone.

  • countrystring or nullrequired

    Country of the store, an ISO 3166-1 alpha-2 code; null when not set.

  • default_localestring or nullrequired

    Main language of the store content; null when not set.

  • supported_localesarray of stringrequired

    Languages the store fills its content in.

Endpoints

Get the store: currency, time zone and languages

get/store

Scope: any token of the store

Responses

200Success

application/json

Returns Store

401The token is missing, invalid, expired or revoked

Headers

  • WWW-Authenticatestringrequired

    Authentication scheme (RFC 6750).

    Example:
    Bearer

application/problem+json

Returns Problem

403The plan, the IP address or the token scopes do not allow the request

Headers

  • WWW-Authenticatestring

    Authentication scheme (RFC 6750).

    Example:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Returns ForbiddenProblem

422A parameter is invalid or unknown

application/problem+json

Returns ValidationProblem

429The rate limit is exhausted

Headers

  • Retry-Afterintegerrequired

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns RateLimitProblem

503The store is temporarily unavailable

Headers

  • Retry-Afterinteger

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns Problem

Common errors such as token, access, input validation and rate limit can come from any endpoint; they are listed in the catalog: Errors

Example request
curl "https://api.saleya.app/v1/store" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Example response · 200
{
  "id": 0,
  "name": {
    "key": "string"
  },
  "currency": "string",
  "timezone": "string",
  "country": "string",
  "default_locale": "string",
  "supported_locales": [
    "string"
  ],
  "marketing_consent_mode": "opt_out"
}