Store

General operations related to the store

Get general information about the store

get

Retrieves general information about the store, including store name, owner, and basic settings.

Authorization:

• Requires a valid JWT Bearer token.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation

application/json

idnumberRequired

Unique identifier of the store.

Example: 762

ownernumberRequired

Unique ID of the store owner account.

Example: 10000

titlestringRequired

Title or name of the store.

Example: Epic store

subtitlestringOptional

Subtitle of the store.

Example: The most epic store you will ever find.

descriptionstringRequired

Description of the store.

Example: The best store in the world!

domainstringRequired

Subdomain used for the store. Full URL: <domain>.tip4serv.com.

Example: epicstore

custom_domainstringOptional

Custom domain registered for the store, if any.

Example: shop.epicstore.com

logostringRequired

URL of the store logo.

Example: https://tip4serv.com/template/images/defaultLogo.jpg

currencystringRequired

Currency used by the store.

Example: USD

timezonestringRequired

Timezone in which timestamps for the store are expressed.

Example: Europe/Paris

colorstringRequired

Main theme color of the store.

Example: #5990f1

403

Missing or invalid Tip4Serv API Key

application/json

500

Internal server error

application/json

get/store/whoami

GET /v1/store/whoami HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 762,
  "owner": 10000,
  "title": "Epic store",
  "subtitle": "The most epic store you will ever find.",
  "description": "The best store in the world!",
  "domain": "epicstore",
  "custom_domain": "shop.epicstore.com",
  "logo": "https://tip4serv.com/template/images/defaultLogo.jpg",
  "currency": "USD",
  "timezone": "Europe/Paris",
  "color": "#5990f1",
  "social_medias": {
    "facebook": "https://www.facebook.com/zuck/",
    "instagram": "https://www.instagram.com/zuck/",
    "tiktok": "https://www.tiktok.com/@openai",
    "twitter": "https://x.com/X",
    "youtube": "https://www.youtube.com/user/PewDiePie",
    "twitch": "https://www.twitch.tv/openai",
    "steam": "https://steamcommunity.com/profiles/76561198380145423"
  },
  "menu_links": [
    {
      "title": "Books",
      "url": "https://duster-books.com"
    }
  ]
}

Get general information about the store theme

get

Retrieves general information about the store's theme, including the current active mode, colors, and associated images.

Authorization:

• Requires a valid JWT Bearer token.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation

application/json

idnumberRequired

Unique identifier of the theme.

Example: 2

short_namestringRequired

Short name of the theme.

Example: neonPattern: ^[a-z0-9_-]+$

namestringRequired

Name of the theme publicly displayed.

Example: Neon Theme

modestringRequired

Default mode of the theme (e.g., light, dark, etc.).

Example: light

403

Missing or invalid Tip4Serv API Key

application/json

500

Internal server error

application/json

get/store/theme

GET /v1/store/theme HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 2,
  "short_name": "neon",
  "name": "Neon Theme",
  "slug": {
    "product": "product",
    "category": "category"
  },
  "images": {
    "favicon": "8651782c6c560e354f81a5e586939495.jpg",
    "light": {
      "logo_header": "2613ab81ede1995cd1024b542962194a.png",
      "logo_footer": "logo2.png",
      "home_cover": "home_cover_inner.jpg"
    },
    "dark": {
      "logo_header": "2613ab81ede1995cd1024b542962194a_dark.png",
      "logo_footer": "logo2_dark.png",
      "home_cover": "home_cover_inner_dark.jpg"
    }
  },
  "mode": "light",
  "widgets": {
    "description": "below_categories_list",
    "top_customer": 1,
    "featured_product": 1,
    "top_product": 1,
    "show_banner": true
  }
}