Check credentials and see which store this key belongs to

GET

/me

curl --request GET \
  --url https://api.oletapp.com/your-store/v1/me \
  --header 'Authorization: Bearer <token>'

A connection test: returns the store name and domain prefix this key belongs to, plus the scopes it was granted and its own id and name.

Requires scope: any

Authorizations

• apiKey
• oauth2

Responses

200

Check credentials and see which store this key belongs to

Media typeapplication/json

object

data

required

object

domain_prefix

required

The retailer’s domain prefix, e.g. https://api.oletapp.com/{domain_prefix}/v1.

string

key

required

object

id

required

string

name

required

string

scopes

required

The scopes this key or app connection was granted.

Array<string>

store_name

required

The retailer’s store name.

string

Example^generated

{
  "data": {
    "domain_prefix": "example",
    "key": {
      "id": "example",
      "name": "example"
    },
    "scopes": [
      "example"
    ],
    "store_name": "example"
  }
}

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"
  }
}