DOCSEARCHbyAlgolia
Submit Docs

Salla Merchant APIs

website·Indexed 34 days ago

https://docs.salla.dev

Documentation for the Salla Merchant APIs, a suite of RESTful services for building apps and integrations. Includes guides on OAuth 2.0 authorization, webhooks, rate limiting, and multi-language support, alongside detailed endpoint references for managing orders, products, customers, shipments, and store settings.

Tokens
145.8K
Snippets
699
Records
1.3K
Agent score
66%

What's inside Salla

  1. Overview of Salla Merchant APIs

    Salla Merchant APIs are a suite of RESTful endpoints designed for secure and fast access to Merchant data. They allow developers to build apps that can scale across over 60,000 online stores and be published to the Salla App Store.

  2. Overview of Twilight JS SDK Localization

    The Twilight JS SDK provides a localization API to manage store translations. All theme languages are loaded by default when the SDK is initialized via salla.init(). Localization files are JSON-based, consisting of key-value pairs located in the /locales/ directory. The SDK's language functionality is based on the Lang.js library.

  3. Overview of Communication Webhooks

    Communication webhooks provide real-time notifications for all outgoing store communications, including SMS, email, and WhatsApp messages. These webhooks allow developers to track customer interactions such as order updates, payment reminders, marketing broadcasts, and product availability alerts.

    Constraint: These webhook events are exclusively available for applications categorized as 'Communication applications'.

  4. Overview of Salla Component Hooks

    Salla Component Hooks provide a JavaScript API to modify UI, intercept validation, and track lifecycle events of Salla web components at runtime without modifying core theme code.

    Key characteristics:

    • Timing Independent: Hooks can be registered before or after components load.
    • Whitelist Secured: Only approved hook names are accepted to prevent unauthorized registrations.
    • Error Isolated: Failures in a hook callback will not crash the core component.
    • No Duplicates: Components are tracked in a Set to ensure a hook only triggers once per element.

  5. Overview of Salla Webhooks

    Salla Webhooks provide automated notifications when specific events occur in a merchant store, such as App installation, order or product creation, or coupon application. These notifications allow developers to trigger external actions or synchronize data between Salla and other systems.

  6. Overview of Twilight JS Web Components

    Twilight JS Web Components are a collection of high-level, reusable web components designed for swiftly developing the UI of custom Salla Themes. These components are built to be compatible with Salla's theme structure and architecture, making them easy to customize. Each component typically includes a set of properties and events for customization and utilizes the Twilight JS SDK to fetch necessary data from the backend.

  7. Overview of Product Option Components in Twilight Engine

    Product options are managed via a set of specialized Twig components located in the src/views/components/product/options directory. These components allow developers to implement various input types for product customization, such as colors, dates, and text fields.
    └── src
  ├── views 
    ├── components
    |   └── product
    |       └── options
    |           ├── color.twig
    |           ├── date.twig
    |           ├── datetime.twig
    |           ├── donation.twig
    |           ├── image.twig
    |           ├── multiple-options.twig
    |           ├── number.twig
    |           ├── single-option.twig
    |           ├── splitter.twig
    |           ├── text.twig
    |           ├── textarea.twig
    |           ├── thumbnail.twig
    |           └── time.twig

  8. Overview of Salla Developer Platform Resources

    Salla provides a suite of tools and APIs for developers to build Apps and Themes for Salla Online Stores. The ecosystem includes RESTful APIs for merchant data, authentication via OAuth 2.0, a CLI for development, and a specialized engine for theme customization.

  9. Overview of Salla Embedded SDK

    The Salla Embedded SDK is a communication bridge designed for third-party applications that run within an iframe inside the Salla Merchant Dashboard. It allows these applications to interact securely with the dashboard to sync themes, handle navigation, trigger UI components, and manage authentication, ensuring the third-party app feels like a native part of the Salla platform.

  10. Overview of Twilight Header Components

    The Twilight engine provides a set of default header-related components located in src/views/components/header. These components include the main header, advertisements, breadcrumbs, and menus.
    └── src
  ├── views 
    ├── components
    |   ...
    |   └── header
    |       ├── header.twig
    |       ├── advertisement.twig
    |       ├── breadcrumbs.twig
    |       ├── menu.twig
    |       ├── menu-item.twig

  11. Overview of the Salla Report Creator

    The Report Creator is a feature within the Salla Partners Portal that enables developers to build custom analytical reports for the Salla store dashboard. It allows developers to bind various visualizations to their own data sources to display specific metrics to merchants. Key capabilities include adding custom reports to the main reports dashboard, creating industry-specific reports, and offering reporting as a paid feature within an app or service.

  12. Overview of Twilight JS SDK

    The Twilight JS SDK is a JavaScript library designed for Salla storefront APIs. It provides developers with helper methods and REST API endpoints to facilitate communication between the frontend and backend, enabling the creation of dynamic merchant stores.