Tjar
    • 🗂️ Overview
    • 🚀 Start Here
    • Orders
      • List Orders
        GET
      • Get Order Details
        GET
      • Order Statuses
        GET
      • Create Order
        POST
      • Change Order Status
        POST
    • Products
      • Digital
        • Create Digital Product
        • Get Digital Product Details
        • Update Digital Product
      • Booking
        • Get Booking Product Details
        • Create Booking Product
        • Update Booking Product
      • Service
        • Get Service Product
        • Create Service Product
        • Update Service Product
      • List All Products
        GET
      • Get Product Details
        GET
      • Create Product
        POST
      • Update Product
        PATCH
      • Delete Product
        DELETE
    • Media
      • Upload Media
        POST
      • Upload Multiple Media
        POST
      • Update Media
        POST
    • Webhook
      • List Webhooks
        GET
      • Register Webhook
        POST
      • Update Webhook
        PUT
      • Delete Webhook
        DELETE
      • Verify Signature
        POST
      • Refresh Secret
        POST
      • Webhook Events
        GET
    • Abandoned Cart
      • List Abandoned Carts
      • Get Abandoned Cart Details
      • Send Reminder

    🗂️ Overview

    Tjar provides a tenant-based API platform that helps developers and partners build reliable integrations for store operations, automation workflows, and external systems.
    Whether you're syncing products, managing orders, uploading media, or subscribing to store events, the Tjar API gives you the building blocks needed to connect your services directly to a Tjar store.

    What you can build#

    Using the Tjar API, you can build:
    order management integrations
    product and catalog sync tools
    media upload workflows
    webhook-driven automations
    internal dashboards and reporting tools
    ERP, OMS, CRM, and fulfillment integrations

    API structure#

    The Tjar API is currently organized into these core sections:

    Orders#

    Create, retrieve, update, and manage store orders.

    Products#

    Work with store products and supported product types.

    Media#

    Upload and update store media files.

    Webhook#

    Register webhook endpoints and receive store events in real time.

    Tenant-based architecture#

    Tjar APIs are tenant-based, which means every store has its own domain and its own API base URL.
    Your requests should always target the store domain you are integrating with.
    Base URL format
    https://{store-domain}/api/core/v1
    Example
    https://example-store.tjar.sa/api/core/v1

    API access from store dashboard#

    To start using the API, store owners or admins can manage credentials directly from the Developers page in the dashboard.
    Dashboard page example
    Open Developers Page
    This page gives access to:
    API key generation
    API key rotation
    API key reveal/copy flow
    webhook registration
    webhook editing
    webhook secret refresh
    webhook deletion
    visible webhook usage limits
    It also shows operational information such as:
    whether an API key exists
    the last update time
    registered webhook endpoints
    webhook events
    webhook capacity status

    Developers page preview#

    Developers Dashboard Screenshot

    Authentication#

    Protected endpoints require an API key.
    You can generate the API key from the store dashboard:
    General Settings → Developers
    Then send the key in the Authorization header:
    Authorization: Bearer {API_KEY}

    Common request headers#

    Most integrations should use these headers:
    Authorization: Bearer {API_KEY}
    Accept: application/json
    Content-Type: application/json
    Accept-Language: en or ar

    Versioning#

    Tjar APIs are versioned.
    The current documented version uses:
    /api/core/v1
    Versioning helps keep integrations stable as the platform evolves.

    Real-time integrations with webhooks#

    If your integration needs immediate updates, use webhooks instead of polling.
    Webhooks allow your system to react automatically when important store events happen, such as:
    order changes
    product updates
    product deletion
    other supported store events
    This is the recommended approach for near real-time automation.

    Webhook usage rules#

    The Developers dashboard also enforces operational webhook limits.
    For example, the current store implementation allows a maximum of 2 webhooks per tenant/store.
    This helps keep integrations controlled and easier to manage.

    Recommended reading path#

    If you're new to the platform, follow this order:
    1.
    🚀 Start Here
    2.
    Orders
    3.
    Products
    4.
    Media
    5.
    Webhook

    Best suited for#

    This API is ideal for:
    internal engineering teams
    implementation partners
    SaaS integrations
    store automation builders
    operations and reporting systems

    Next step#

    Continue to 🚀 Start Here to make your first authenticated request and understand the basic integration flow.
    Modified at 2026-04-08 16:58:55
    Next
    🚀 Start Here
    Built with