🚀 Start Here

This guide will help you make your first successful request to the Tjar API.

If you're integrating for the first time, start here before exploring the endpoint reference.

Before you begin

Make sure you have:

access to the target Tjar store

permission to use the Developers/API section

a valid API key

the correct store domain

a tool to test requests, such as cURL, Postman, or your backend application

Step 1 — Open the Developers page

Before calling the API, open the store dashboard Developers page:

Open Developers Page

From this page, you can:

generate an API key

rotate the API key

reveal/copy the generated key

manage webhook secrets

view webhook status and capacity

Developers page screenshot

Step 2 — Generate an API key

To access protected endpoints, generate an API key from the Developers page.

Path inside dashboard:

General Settings → Developers

Keep your API key secure. Do not expose it in frontend code or public client applications.

Step 3 — Identify the store domain

Tjar APIs are tenant-based, so each store uses its own domain.

Examples:

store1.tjar.sa

demo-store.tjar.test

You will use that domain as the base of every API request.

Step 4 — Build the base URL

Use this format:

https://{store-domain}/api/core/v1

Example

https://example-store.tjar.sa/api/core/v1

Step 5 — Send your first request

A simple first request is listing orders.

Example request

Step 6 — Understand the request headers

Authorization

Used to authenticate protected requests.

Authorization: Bearer {API_KEY}

Accept

Requests JSON responses.

Accept: application/json

Accept-Language

Controls localized responses where supported.

Accept-Language: en

Accept-Language: ar

Content-Type

Used when sending JSON request bodies.

Content-Type: application/json

Step 7 — Read the response

Successful responses typically include structured JSON containing:

a success status

a message

returned data

pagination metadata for list endpoints

If the request fails, verify:

the API key is valid

the store domain is correct

the endpoint path is correct

required headers are included

the request body matches the endpoint specification

the store user has the required permissions

Step 8 — Configure webhooks

Once your first request works, you can return to the Developers page to register webhook endpoints.

This is useful if your integration needs near real-time updates for:

order changes

product changes

store event processing

external system synchronization

Webhooks page screenshot

Best practices

Follow these recommendations when building your integration:

store API keys securely on the server side

never expose secrets in browser-based code

use pagination when working with list endpoints

validate incoming webhook payloads

log request and response errors for debugging

test in a safe environment before going live

rotate API keys carefully if multiple systems depend on them

Recommended next pages

Need help?

If you're unsure where to begin, start with:

Orders for operational workflows

Products for catalog sync

Webhook for automation and event-driven integrations

You're now ready to begin building with the Tjar API.

🚀 Start Here

Before you begin#

Step 1 — Open the Developers page#

Developers page screenshot#

Step 2 — Generate an API key#

Step 3 — Identify the store domain#

Step 4 — Build the base URL#

Step 5 — Send your first request#

Example request#

Step 6 — Understand the request headers#

Authorization#

Accept#

Accept-Language#

Content-Type#

Step 7 — Read the response#

Step 8 — Configure webhooks#

Webhooks page screenshot#

Best practices#

Recommended next pages#

Need help?#