1. Report Builder
Salla Platform Docs
  • Embedded SDK
    • Overview
    • Getting Started
    • Create an Embedded App
    • Authentication
    • App Design Guidelines
    • Installation
    • Playground
  • Auth Module
    • Get Token
    • Client Introspect
    • Refresh Token
  • Page Module
    • External Redirects
    • Navigation
    • Set Page Title
  • Nav Module
    • Create Navbar Action
    • Listen for Navbar Actions
    • Clearing Navbar Actions
    • Add Navbar Item
    • Update Navbar Item
    • Listen for Navbar Item Click
    • Remove Navbar Item
  • UI Module
    • Confirm Dialogs
    • Toast Notifications
    • Loading States
    • Breadcrumbs
  • Checkout Module
    • Create Checkout
    • Get App Add-ons
    • Subscribe for Payment Result
  • Endpoints
    • Token Introspect
      POST
  • Resources
    • Support
    • Common Examples
  • Report Builder
    • Overview
    • Getting Started
    • JMESPath Tutorial
    • Understanding the Report Lifecycle
    • Salla Reports Examples
    • Set up Store data using merchant APIs
    • Report Types
      • Unit
      • Bar
      • Breakdown
      • Calendar
      • Distribution
      • Pipe
      • Plot
      • Ranking
      • Summary
      • Agrid
    • APIs
      • Token Introspect
  • App Onboarding
    • Overview
    • Get Started
    • Interfaces and Responses
    • Example
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Report Builder

Set up Store data using merchant APIs

Setting up store data through Salla’s Merchant APIs is the basis for building powerful integrations with the Salla platform. Whether you’re developing analytics tools, automating workflows, or creating custom solutions for merchants, the first step is understanding how to securely connect, retrieve, and structure store data.
This article walks you through the full process; from authenticating with OAuth, to configuring your server, to interpreting the JSON content structure that powers Salla’s APIs.
By the end, you’ll not only know how to set up and test your app in a safe demo environment, but also how to map fields, rows, and pagination so you can reliably access and use the store data in real-world applications.

Authentication#

For security reasons Salla enforces authentication layer for Partners accounts accessing stores, therefore you can use OAuth to gain access to Merchants' stores with either Easy Mode or Custom Mode, using access tokens via the Apps built on Salla Partners Portal, which will be published on Salla App Store.
Authentication Steps:
1
Open and verify a partner account on Salla Partners portal.
2
Either use a sample App you created previously or build a new one from scratch.
3
Choose an OAuth method, Easy Mode or Custom Mode Authorization.
4
Set up the scopes of your App to specify the needed access level.
5
Generate a demo store, so no sensitive data is compromised.
6
Install the App on the demo store for a real-world mockup test.
Read more about authorization for Salla Apps here.

Once you finish the authentication you can proceed to set up your server.

Server Set Up#

Setting up the server is crucial to get the data you need from Salla stores, follow these steps to set up the server.
Server Setup Steps:
1
First Step
Get your Client Secret Key from the App details page in Partners Portal.
2
Second Step
Get the Token from the request.
3
Third Step
Verify the Client Secret Key and the Token using debugger such as JWT.

Content Structure#

This defines the framework that defines the type of data, content parts, how these parts relate to each other.
In APIs / Data The JSON has a content structure:
fields → schema (what data exists).
rows → actual values.
cursor → pagination.
This structure tells you where to find what.

Data Structure Explanation Example#

For the below JSON data structure, each part will be explained in details.
1. fields → schema (the blueprint)
Think of fields as the column headers in a database table.
Each object describes:
"name" → the name of the field (like a column name).
"type" → what kind of data goes in there (float, integer, string).
Example:
sales_cost_price (float)
order_counts (integer)
This tells you what kind of data to expect and how to interpret it.
2. rows → actual values (the data itself)
Each array inside rows is a record, where the values line up with the fields definition.
Order matters → the first value corresponds to the first field, second to the second field, etc.
Example mapping:
38830 → sales_cost_price
10894.53 → total_sales
68 → order_counts
So rows is like the spreadsheet rows beneath the headers.
3. cursor → pagination
This section tells you where you are in the dataset, especially if there are many rows.
"current": 1 → you are on page 1.
"previous": null → no earlier page.
"next": null → no later page.
"count": 1 → total number of pages is 1.
This allows you to fetch chunks of data instead of loading everything at once.

Putting It Together#

The JSON is basically a mini database table packaged in JSON:
sales_cost_pricetotal_salesorder_counts
3883010894.5368
fields = table headers (schema).
rows = table rows (data).
cursor = navigation through pages of this table.
Therefore the content structure in APIs is the predictable layout of metadata (fields), data (rows), and navigation (cursor) that tells clients how to extract and use the information.

Server Example#

This server example shows how the data structure is set up follwoing Salla report tool.
By getting here you have successfully authenticated the connection between your app and the store for a seamless integration. In addition to setting up the data structure, you can now create Reports easily and efficiently.
Modified at 2026-05-12 12:27:31
Previous
Salla Reports Examples
Next
Unit