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.
Store
Objects
Store
idintegerrequiredID of the store.
namemap of stringrequiredName of the store by language.
currencystringrequiredCurrency 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.
timezonestringrequiredTime zone of the store, an IANA name. Calendar dates of the API, such as reopens_on, are dates in this zone.
countrystring or nullrequiredCountry of the store, an ISO 3166-1 alpha-2 code; null when not set.
default_localestring or nullrequiredMain language of the store content; null when not set.
supported_localesarray of stringrequiredLanguages the store fills its content in.
marketing_consent_modestringrequiredWhich consent to marketing messages the store finds enough: opt_out — everyone who has not unsubscribed; opt_in — only customers who agreed explicitly (marketing_consents of the customer). WhatsApp always requires explicit consent.
- Values:
opt_outopt_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-AuthenticatestringrequiredAuthentication 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-AuthenticatestringAuthentication 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-AfterintegerrequiredSeconds to wait before retrying.
- Minimum:
- 0
application/problem+json
Returns RateLimitProblem
503The store is temporarily unavailable
Headers
Retry-AfterintegerSeconds 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
curl "https://api.saleya.app/v1/store" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"name": {
"key": "string"
},
"currency": "string",
"timezone": "string",
"country": "string",
"default_locale": "string",
"supported_locales": [
"string"
],
"marketing_consent_mode": "opt_out"
}