Skip to content

Get store settings

Open in ClaudeOpen in ChatGPTView as Markdown
GET
/store
curl --request GET \
  --url https://api.oletapp.com/your-store/v1/store \
  --header 'Authorization: Bearer <token>'

Readable by any valid credential: it is reference data needed to interpret every other resource. Returns store_name, domain_prefix (the prefix on every API path and the OAuth token response’s api_base_url), currency, and tax_inclusive.

Requires scope: any

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Get store settings

Media typeapplication/json
object
data
required
object
currency
required
string
domain_prefix
required
string
store_name
required
string
tax_inclusive
required
boolean
Examplegenerated
{
  "data": {
    "currency": "example",
    "domain_prefix": "example",
    "store_name": "example",
    "tax_inclusive": true
  }
}

default

Section titled “default”

An error response.

Media typeapplication/json
object
error
required
object
code
required

A machine-readable error code, e.g. VALIDATION_FAILED.

string
Allowed values: UNAUTHORIZED PLAN_REQUIRED INSUFFICIENT_SCOPE NOT_FOUND VALIDATION_FAILED CONFLICT STALE_VERSION RATE_LIMITED IDEMPOTENCY_KEY_REUSED IDEMPOTENCY_IN_PROGRESS IMAGE_FETCH_FAILED UNPROCESSABLE INTERNAL RETAILER_CANCELLED RETAILER_SUSPENDED RETAILER_NOT_FOUND TRIAL_DECISION_REQUIRED PLAN_USERS_EXCEEDED RETAILER_PAUSED PRODUCT_LIMIT_REACHED NOT_STOCK_TRACKED REASON_DIRECTION_MISMATCH REASON_NOT_ALLOWED INSUFFICIENT_STOCK OUTLET_DELETED
fields
Array<object>
object
field
required
string
message
required
string
message
required

A plain-English sentence describing what went wrong.

string
Example
{
  "error": {
    "code": "UNAUTHORIZED"
  }
}