Salla

https://docs.salla.dev/
Admin
Salla is an e-commerce platform providing a comprehensive API for merchants to manage products,...
Tokens:1,289,112
Snippets:8,549
Trust Score:7.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Size Guides Response

Source: https://docs.salla.dev/api-6965781

Example response for product size guide definitions.

```json
{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1298199463,
      "name": "Size 4",
      "description": "test size 4",
      "type": 1,
      "enablec": false,
      "brands": [
        "2079537577"
      ],
      "translations": {
        "ar": {
          "name": "Size 4",
          "description": "test size 4"
        }
      }
    },
    {
      "id": 1939592358,
      "name": "Size 3",
      "description": "test size 3",
      "type": 2,
      "enablec": false,
      "categories": [
        "1908230909"
      ],
      "translations": {
        "ar": {
          "name": "Size 3",
          "description": "test size 3"
        }
      }
    },
    {
      "id": 566146469,
      "name": "Size 2",
      "description": "test Size 2",
      "type": 1,
      "enablec": false,
      "brands": [
        "814202285"
      ],
      "translations": {
        "ar": {
          "name": "Size 2",
          "description": "test Size 2"
        }
      }
    },
    {
      "id": 1473353380,
      "name": "Size 1",
      "description": "test size 1",
      "type": 2,
      "enablec": false,
      "categories": [
        "1134193150"
      ],
      "translations": {
        "ar": {
          "name": "Size 1",
          "description": "test size 1"
        }
      }
    }
  ]
}
```

--------------------------------

### Install dependencies

Source: https://docs.salla.dev/2140786m0

Install the necessary project dependencies before running the development server.

```bash
pnmp i
```

--------------------------------

### Clone and Install Starter Kit

Source: https://docs.salla.dev/1724504m0

Commands to clone the repository and install necessary dependencies.

```bash
git clone https://github.com/SallaApp/store-events-tracker-starter-kit
```

```bash
cd store-events-tracker-starter-kit
pnpm install
```

--------------------------------

### Clone and Run the Starter Kit

Source: https://docs.salla.dev/1724504m0

Use the starter kit to quickly test event tracking in a local development environment.

```bash
git clone https://github.com/SallaApp/store-events-tracker-starter-kit
cd store-events-tracker-starter-kit
pnpm install
pnpm dev
```

--------------------------------

### App Installed Event Payload

Source: https://docs.salla.dev/421413m0

Example JSON payload received when an app is successfully installed on a merchant store.

```json
{
  "event": "app.installed",
  "merchant": 1234509876,
  "created_at": "2022-12-31 12:31:25",
  "data": {
    "id": 6789012345,
    "app_name": "Shipping app",
    "description": "App Description"
    "app_type": "app",
    "app_scopes": [
      "settings.read",
      "customers.read_write",
      "orders.read_write",
      "carts.read",
      "branches.read_write",
      "categories.read_write",
      "brands.read_write",
      "products.read_write",
      "webhooks.read_write",
      "payments.read",
      "taxes.read_write",
      "specialoffers.read_write",
      "countries.read",
      "metadata.read_write",
      "offline_access"
    ],
    "installation_date": "2021-09-28 06:06:56",
    "store_type": "development"
  }
}
```

--------------------------------

### Forbidden Error Response Examples

Source: https://docs.salla.dev/37396517e0

Examples of 403 Forbidden error responses for app installation and payment failure scenarios.

```yaml
summary: App Not Installed
                  value:
                    status: 403
                    success: false
                    error:
                      code: app_not_installed
                      message: The app is not installed for this store.
                '7':
                  summary: Payment Failed
                  value:
                    status: 403
                    success: false
                    error:
                      code: payment_failed
                      message: Payment processing failed for this renewal.
```

--------------------------------

### Run the development server

Source: https://docs.salla.dev/2140786m0

Start the local development server to preview and test the theme bundle.

```bash
pnmp dev
```

--------------------------------

### Initialize and Preview Theme

Source: https://docs.salla.dev/421878m0

Commands to navigate to the theme directory, install dependencies, and launch the local preview server.

```shell
> cd theme_folder_name
> npm install
> salla theme preview
```

--------------------------------

### Configure Installment Payment Options

Source: https://docs.salla.dev/422707m0

If using the installment component outside of store pages, configure the available installment payment options using `salla.config.set`. This example enables Tamara, Tabby, and Spotii.

```js
salla.config.set('store.settings.installments', {
  tamara_installment: true,
  tabby_installment: true,
  spotii_pay: true
})
```

--------------------------------

### Access the Example File

Source: https://docs.salla.dev/1724504m0

Open this file in your browser to trigger actions and view emitted events in the console.

```text
example.html
```

--------------------------------

### GET /reservations

Source: https://docs.salla.dev/5579097e0

Retrieves a list of all current order reservations based on the provided start and end dates.

```APIDOC
## GET /reservations

### Description
This endpoint allows you to retrieve all the current order reservations.

### Method
GET

### Endpoint
/reservations

### Parameters
#### Query Parameters
- **start** (string, date) - Required - Reservation start date
- **end** (string, date) - Required - Reservation end date

### Response
#### Success Response (200)
- **status** (integer) - Response status code
- **success** (string) - Response flag
- **data** (array) - List of reservations

#### Response Example
{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1473353380,
      "title": "تعليم القيادة (2)",
      "type": "day",
      "start": "2024-02-16T00:00:00",
      "end": "2024-02-16T23:59:59",
      "seats_count": 2,
      "url": "https://dashboard.test/orders/order/yRdxQ9m28rEbamllyGd1Xz5KoDJZgkAP",
      "created_at": "2024-02-13 13:48:33"
    }
  ]
}
```

--------------------------------

### Set store configuration via salla.init()

Source: https://docs.salla.dev/422612m0

Initializes the SDK with store-specific settings during startup.

```js
salla.init({ 
  debug: true, 
  store: { 
    id: 123451234, 
    url: "https://my_store.test/",  
    name: "WOW store", 
    settings: { auth: { email_allowed: false } } 
  }
});
```

--------------------------------

### OpenAPI Specification for Affiliate Details

Source: https://docs.salla.dev/5394271e0

The OpenAPI definition for the GET /affiliates/{affiliates_id} endpoint, including request parameters and response examples.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /affiliates/{affiliates_id}:
    get:
      summary: Affiliate Details
      deprecated: false
      description: >-
        This endpoint allows you to fetch details regarding an affiliate by
        passing the `affiliate_id` as a path parameter.


        :::danger[Deprecation Notice]

        Starting **November 01, 2025**, this endpoint’s response will be
        updated, and the old response body will be deprecated.

        To avoid breaking changes, update your integration to use the new
        schema, which supports the [new Salla affiliate
        system](https://help.salla.sa/article/501443344).

        If the Merchant is still using the old Salla affiliate system, the
        endpoint will still depend on deprecated payloads.

        See the [ChangeLog](https://docs.salla.dev/421127m0) for more details.

        :::


        <Accordion title="Scopes" defaultOpen={true} icon="lucide-key-round">

        `marketing.read`- Marketing Read Only

        </Accordion>
      operationId: get-affiliates-affiliates.id
      tags:
        - Default module/Merchant API/APIs/Affiliates
        - Affiliates
      parameters:
        - name: affiliates_id
          in: path
          description: >-
            Unique identification number assigned to the Affiliate. List of
            Affiliate IDs can be found
            [here](https://docs.salla.dev/api-5394270).
          required: true
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/affiliate_response_body'
              example:
                status: 200
                success: true
                data:
                  id: 326633404
                  title: this is marketing link
                  type: public
                  apply_to: first-second-order
                  commission:
                    type: percent
                    value: 50
                    minimum_apply: 0
                  discount:
                    type: percent
                    value: 50
                  scopes:
                    - id: 1234567
                      name: salla-store
                      type: store
                      link: https://salla.sa/intend/1234567
                      operation: include
                      thumbnail: >-
                        https://cdn.salla.sa/oEGE/03m2U2cnDGZck7WZNEDJgzMrrtH3MsBmMKXhoIV1.png
                  start_date: ''
                  end_date: ''
                  status: active
                  hide_total_stats: false
                  statistics:
                    visits: 2
                    sales:
                      amount: 21
                      currency: SAR
                    profit:
                      amount: 50
                      currency: SAR
                    orders_count: 1
          headers: {}
          x-apidog-name: Default Response
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_unauthorized_401'
              example:
                status: 401
                success: false
                error:
                  code: Unauthorized
                  message: >-
                    The access token should have access to one of those scopes:
                    marketing.read
          headers: {}
          x-apidog-name: Unauthorized
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object%20Not%20Found(404)'
              example:
                status: 404
                success: false
                error:
                  code: error
                  message: المحتوى الذي تحاول الوصول اليه غير متوفر
          headers: {}
          x-apidog-name: Not Found
        x-200:Deprecated Response:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/old_affiliate_response_body'
              example:
                status: 200
                success: true
                data:
                  id: 611208326
                  code: afl11
                  marketer_name: User Name
                  marketer_city: Medina
                  commission_type: fixed
                  amount:
                    amount: 300
                    currency: SAR
                  profit:
                    amount: 150
                    currency: SAR
                  links:
                    affiliate: >-
                      https://salla.sa/dev-wofftr4xsra5xtlv?utm_source=aff&utm_campaign=CXNAZ
                    statistics: >-
```

--------------------------------

### Define URL navigation structure

Source: https://docs.salla.dev/5394121e0

Example structure for the URLs object used to guide merchants and customers to specific dashboard or store pages.

```yaml
customer: https://shtara.com/profile
admin: https://shtara.com/profiles
```

--------------------------------

### Initialize SDK Application

Source: https://docs.salla.dev/embedded-sdk/installation

Complete example for initializing the SDK, handling authentication, and signaling readiness.

```typescript
import { embedded } from "@salla.sa/embedded-sdk";

async function bootstrapApp() {
  try {
    // 1. Initialize SDK and get dashboard context
    const { layout } = await embedded.init({ debug: true });
    
    // 2. Handle token verification
    const token = embedded.auth.getToken();
    if (!token) throw new Error("Unauthorized");
    
    // ... Verify token with your backend ...

    // 3. Signal that the app is ready for the user
    embedded.ready();
    
    // Set a native page title
    embedded.page.setTitle("My App Dashboard");
    
  } catch (err) {
    console.error("SDK initialization failed", err);
    embedded.destroy(); // Exit the embedded view on error
  }
}

bootstrapApp();
```

--------------------------------

### Initialize Twilight JS SDK with Basic Configuration

Source: https://docs.salla.dev/422610m0

Use salla.init() to initialize the SDK with required store information.

```js
<script>
  salla.init({
    debug: true, // disbale it in prod
    language_code: 'ar', // en
    store: {
      id: 1305146709, // The store id can found via store pages.
      url: "https://the-best-store-ever.sa"
    }
  });
</script>
```

--------------------------------

### OpenAPI Specification for List Currencies

Source: https://docs.salla.dev/api-5394257

The OpenAPI definition for the /currencies GET endpoint, including request security, response schemas, and example payloads.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /currencies:
    get:
      summary: List Currencies
      deprecated: false
      description: >-
        This endpoint allows you to fetch a list of all currencies alongside
        their details, such as `name`, `code`, `symbol` and `status`.


        <Accordion title="Scopes" defaultOpen={true} icon="lucide-key-round">

        `metadata.read`- Metadata Read Only

        </Accordion>
      operationId: get-currencies
      tags:
        - Default module/Merchant API/APIs/Currencies
        - Currencies
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/currencies_response_body'
              example:
                status: 200
                success: true
                data:
                  - name: ريال سعودي
                    code: SAR
                    symbol: ر.س
                    status: disabled
                  - name: درهم اماراتي
                    code: AED
                    symbol: ' د.إ'
                    status: enabled
                  - name: جنيه مصري
                    code: EGP
                    symbol: ج.م
                    status: enabled
                  - name: دولار أمريكي
                    code: USD
                    symbol: $
                    status: enabled
          headers: {}
          x-apidog-name: Success
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_unauthorized_401'
              example:
                status: 401
                success: false
                error:
                  code: Unauthorized
                  message: >-
                    The access token should have access to one of those scopes:
                    metadata.read
          headers: {}
          x-apidog-name: Unauthorized
      security:
        - oauth21:
            - offline_access
      x-salla-php-method-name: list
      x-salla-php-return-type: Currencies
      x-salla-php-return-base-type: array
      x-apidog-folder: Default module/Merchant API/APIs/Currencies
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/451700/apis/api-5394257-run
components:
  schemas:
    currencies_response_body:
      type: object
      properties:
        status:
          type: number
          description: >-
            Response status code, a numeric or alphanumeric identifier used to
            convey the outcome or status of a request, operation, or transaction
            in various systems and applications, typically indicating whether
            the action was successful, encountered an error, or resulted in a
            specific condition.
        success:
          type: boolean
          description: >-
            Response flag, boolean indicator used to signal a particular
            condition or state in the response of a system or application, often
            representing the presence or absence of certain conditions or
            outcomes.
        data:
          type: array
          x-stoplight:
            id: tiveeiv2mfvp2
          items:
            $ref: '#/components/schemas/Currencies'
      x-apidog-orders:
        - status
        - success
        - data
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Currencies:
      type: object
      properties:
        name:
          type: string
          description: Name of the currency
          examples:
            - ريال سعودي
        code:
          type: string
          description: Code of the currency
          examples:
            - SAR
        symbol:
          type: string
          description: Symbol of the currency
          examples:
            - ر.س
        status:
          type: string
          description: Status of the currency. The value is either `Enabled` or `Disabled`
          enum:
            - enabled
            - disabled
          examples:
            - disabled
          x-apidog-enum:
            - value: enabled
              name: ''
              description: Currency is enabled.
            - value: disabled
              name: ''
              description: Currency is diabled.
      x-apidog-orders:
        - name
        - code
        - symbol
        - status
      required:
        - name
        - code
        - symbol
        - status
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    error_unauthorized_401:
      type: object
      properties:
        status:
          type: number
          description: >-
            Response status code, a numeric or alphanumeric identifier used to
            convey the outcome or status of a request, operation, or transaction
```

--------------------------------

### OpenAPI Specification for Setting Details

Source: https://docs.salla.dev/6965781e0

Defines the GET endpoint for retrieving settings by slug, including parameters and multiple success response examples.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /settings/fields/{slug}:
    get:
      summary: Setting Details
      deprecated: false
      description: >-
        This endpoint allows you to fetch settings details for a specific slug
        by passing the `slug` as a path parameter.


        :::info[Read More]

        For more on Store Settings, check the Merchant's Help Desk article
        [here](https://help.salla.sa/article/1887201789)

        :::


        <Accordion title="Scopes" defaultOpen={true} icon="lucide-key-round">

        `store-settings.read`- Settings Read Only

        </Accordion>
      operationId: get-settings-slug
      tags:
        - Default module/Merchant API/APIs/Settings
        - Settings
      parameters:
        - name: slug
          in: path
          description: >-
            Unique identifier or URL-friendly name assigned to the Settings .
            Get a list of Settings Slugs from
            [here](https://docs.salla.dev/api-6965777)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/slugSettings_response_body'
              examples:
                '1':
                  summary: Success | Receive Orders
                  value:
                    status: 200
                    success: true
                    data:
                      receive_orders: true
                      limit:
                        enable: false
                        count: 50
                        message:
                          ar: "ياهلا {name}\r\n نعتذر عميلنا العزيز، لايمكن استقبال طلبك اليوم لوصولنا للحد الاعلى لطلبات اليوم، يمكنك الطلب بعد {time}."
                          en: "ياهلا {name}\r\n نعتذر عميلنا العزيز، لايمكن استقبال طلبك اليوم لوصولنا للحد الاعلى لطلبات اليوم، يمكنك الطلب بعد {time}."
                          zh: "ياهلا {name}\r\n نعتذر عميلنا العزيز، لايمكن استقبال طلبك اليوم لوصولنا للحد الاعلى لطلبات اليوم، يمكنك الطلب بعد {time}."
                '3':
                  summary: Success | Recieving Times
                  value:
                    saturday:
                      enabled: true
                      from: '00:00'
                      to: '23:55'
                    sunday:
                      enabled: false
                      from: '00:00'
                      to: '23:55'
                    monday:
                      enabled: false
                      from: '00:00'
                      to: '23:55'
                    tuesday:
                      enabled: false
                      from: '00:00'
                      to: '23:55'
                    wednesday:
                      enabled: false
                      from: '00:00'
                      to: '23:55'
                    thursday:
                      enabled: false
                      from: '00:00'
                      to: '23:55'
                    friday:
                      enabled: false
                      from: '00:00'
                      to: '23:55'
                '4':
                  summary: Success | Reports Order Statuses
                  value:
                    status: 200
                    success: true
                    data:
                      order_statuses:
                        - id: 1
                          name: بإنتظار الدفع
                          selected: true
                        - id: 2
                          name: بإنتظار المراجعة
                          selected: true
                        - id: 3
                          name: قيد التنفيذ
                          selected: true
                        - id: 4
                          name: تم التنفيذ
                          selected: true
                        - id: 8
                          name: جاري التوصيل
                          selected: true
                        - id: 9
                          name: تم التوصيل
                          selected: false
                        - id: 10
                          name: تم الشحن
                          selected: false
                        - id: 11
                          name: بإنتظار تأكيد الدفع
                          selected: true
                        - id: 13
                          name: طلب عرض سعر
                          selected: false
                '5':
                  summary: Success | Products Purchase Count
                  value:
                    enabled: true
                    condition:
                      enabled: false
                      categories: []
                '6':
                  summary: Success | Products Recommendations
                  value: |-
                    {
                        "enabled": true,
```

--------------------------------

### Install all skills

Source: https://docs.salla.dev/2228619m0

Use this command to install the entire library of skills from the Salla Partners Agent Kit repository.

```bash
npx skills add SallaApp/salla-partners-agent-kit
```

--------------------------------

### Project Structure Overview

Source: https://docs.salla.dev/1724504m0

Visual representation of the starter kit directory structure.

```text
store-events-tracker-starter-kit
│
├── src
│   ├── listeners
│   │   ├── cart-updated.ts
│   │   ├── product-added.ts
│   │   └── checkout-started.ts
│   │
│   ├── tracker.ts
│   └── index.ts
│
├── example.html
├── package.json
└── vite.config.ts
```

--------------------------------

### OpenAPI Specification for Coupon Details

Source: https://docs.salla.dev/5394276e0

Defines the GET endpoint for retrieving coupon details and includes response examples for success and error states.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /coupons/{coupon_id}:
    get:
      summary: Coupon Details
      deprecated: false
      description: >2-
         This endpoint allows you to fetch details regarding a coupon by passing the `coupon_id` as a path parameter.


        :::info[]

        Use the [Coupon Statistics Details](https://docs.salla.dev/api-35525609)
        endpoint to retrieve coupon statistics details.

        :::


        <Accordion title="Scopes" defaultOpen={true} icon="lucide-key-round">

        `marketing.read`- Marketing Read Only

        </Accordion>
      operationId: get-coupons-coupon.id
      tags:
        - Default module/Merchant API/APIs/Coupons
        - Coupons
      parameters:
        - name: coupon_id
          in: path
          description: ' Unique identification number assigned to the Coupon. List Coupon IDs can be found [here](https://docs.salla.dev/api-5394275).'
          required: true
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/coupon_response_body'
              examples:
                '1':
                  summary: Example
                  value:
                    status: 200
                    success: true
                    data:
                      id: 6930446
                      code: DEAL
                      type: fixed
                      status: active
                      is_apply_with_offer: true
                      amount:
                        amount: 30
                        currency: SAR
                      minimum_amount: null
                      maximum_amount:
                        amount: 0
                        currency: SAR
                      show_maximum_amount: false
                      expiry_date: '2023-03-17 00:00:00'
                      start_date: null
                      free_shipping: true
                      usage_limit: null
                      usage_limit_per_user: null
                      include_product_ids: []
                      exclude_product_ids: []
                      is_sale_products_exclude: true
                      include_category_ids: []
                      exclude_category_ids: []
                      include_customer_group_ids: []
                      exclude_customer_group_ids: []
                      exclude_brands_ids: []
                      exclude_shipping_ids: []
                      include_payment_methods: []
                      applied_in: all
                      is_group: true
                      group_name: Deals
                      group_coupons_count: 3
                      group_coupon_suffix: DEAL
                      group_coupons:
                        - code: DEAL5Wsl
                        - code: DEALgaNN
                        - code: DEALFRa7
                      beneficiary_domain: null
                      statistics:
                        num_of_usage: 0
                        num_of_customers: 0
                        coupon_sales:
                          amount: 0
                          currency: SAR
                      created_at:
                        date: '2022-04-06 12:55:06.000000'
                        timezone_type: 3
                        timezone: Asia/Riyadh
                      updated_at:
                        date: '2022-04-06 12:55:06.000000'
                        timezone_type: 3
                        timezone: Asia/Riyadh
                      marketing_active: false
                      marketing_name: null
                      marketing_type: null
                      marketing_amount: null
                      marketing_hide_total_sales: false
                      marketing_show_maximum_amount: false
                      marketing_maximum_amount: null
                      marketing_info: null
                      marketing_visits_count: null
                      marketing_url: null
                      marketing_statistics_url: null
                '2':
                  summary: Example
                  value:
                    status: 404
                    success: false
                    error:
                      code: error
                      message: المحتوى الذي تحاول الوصول اليه غير متوفر
                '3':
                  summary: Example
                  value:
                    status: 404
                    success: false
                    error:
                      code: error
                      message: المحتوى الذي تحاول الوصول اليه غير متوفر
                '4':
                  summary: Unauthorized
                  value:
                    status: 401
                    success: false
                    error:
```

--------------------------------

### Run Development Environment

Source: https://docs.salla.dev/1724504m0

Command to start the development server.

```bash
pnpm dev
```

--------------------------------

### Advertisement Details OpenAPI Specification

Source: https://docs.salla.dev/5394266e0

The OpenAPI definition for the GET /advertisements/{advertisements_id} endpoint, including parameters, security requirements, and response examples.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /advertisements/{advertisements_id}:
    get:
      summary: Advertisement Details
      deprecated: false
      description: >
        This endpoint allows you to list an existing advertisement post by
        passing the `advertisement_id` as a path parameter. 



        <Accordion title="Scopes" defaultOpen={true} icon="lucide-key-round">

        `marketing.read`- Marketing Read Only

        </Accordion>
      operationId: get-advertisements-advertisements_id
      tags:
        - Default module/Merchant API/APIs/Advertisements
        - Advertisements
      parameters:
        - name: advertisements_id
          in: path
          description: ' Unique identification number assigned to the Advertisement. List of Advertisement IDs can be found [here](https://docs.salla.dev/api-5394265).'
          required: true
          example: 0
          schema:
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/advertisement_response_body'
              example:
                status: 200
                success: true
                data:
                  id: 2142305900
                  title: جميع المنتجات ستتوفر مرة أخرى بعد العيد
                  description: توفر المنتجات
                  type:
                    id: 1032561074
                    name: category
                    link: https://productLink
                  style:
                    icon: sicon-braille-hand
                    font_color: '#ffffff'
                    background_color: '#9d8383'
                  expire_date:
                    date: '2022-01-21 00:00:00.000000'
                    timezone_type: 3
                    timezone: Asia/Riyadh
                  pages:
                    - all
          headers: {}
          x-apidog-name: Success
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_unauthorized_401'
              example:
                status: 401
                success: false
                error:
                  code: Unauthorized
                  message: >-
                    The access token should have access to one of those scopes:
                    marketing.read
          headers: {}
          x-apidog-name: Unauthorized
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object%20Not%20Found(404)'
              example:
                status: 404
                success: false
                error:
                  code: error
                  message: المحتوى الذي تحاول الوصول اليه غير متوفر
          headers: {}
          x-apidog-name: Not Found
      security:
        - oauth21:
            - offline_access
      x-salla-php-method-name: retrieve
      x-salla-php-return-type: Advertisement
      x-apidog-folder: Default module/Merchant API/APIs/Advertisements
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/451700/apis/api-5394266-run
components:
  schemas:
    advertisement_response_body:
      type: object
      properties:
        status:
          type: number
          description: >-
            Response status code, a numeric or alphanumeric identifier used to
            convey the outcome or status of a request, operation, or transaction
            in various systems and applications, typically indicating whether
            the action was successful, encountered an error, or resulted in a
            specific condition.
        success:
          type: boolean
          description: >-
            Response flag, boolean indicator used to signal a particular
            condition or state in the response of a system or application, often
            representing the presence or absence of certain conditions or
            outcomes.
        data:
          $ref: '#/components/schemas/Advertisement'
      x-apidog-orders:
        - status
        - success
        - data
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Advertisement:
      type: object
      properties:
        id:
          type: number
          description: Advertisement ID
        title:
          type: string
          description: Advertisement Title
        description:
          type: string
          description: Advertisement Description. 🌐 [Support multi-language](doc-421122)
        type:
          type: object
          properties:
            id:
              type: number
              description: Advertisement Type ID
            name:
              type: string
              description: Advertisement Type Name
            link:
```

--------------------------------

### GET /customers/loyalty/points

Source: https://docs.salla.dev/12250577e0

Fetches the history of a customer's loyalty points. This endpoint requires the 'customers.read' scope and the Customer Loyalty application to be installed.

```APIDOC
## GET /customers/loyalty/points

### Description
This endpoint allows you to fetch the history of a customer's loyalty points that is associated with the store. This endpoint will work only if the store has the Customer Loyalty application installed.

### Method
GET

### Endpoint
/customers/loyalty/points

### Parameters
#### Query Parameters
- **customer_id** (string) - Required - Unique identification number assigned to the Customer.

### Response
#### Success Response (200)
- **status** (integer) - Response status code.
- **success** (boolean) - Response flag indicating success.
- **data** (array) - List of loyalty point records.
- **pagination** (object) - Pagination details for the results.

#### Response Example
{
  "status": 200,
  "success": true,
  "data": [
    {
      "name": "مخصصة",
      "points": 900,
      "used_points": 0,
      "status": "مؤكدة",
      "created_at": {
        "date": "2024-12-17 17:42:14.000000",
        "timezone_type": 3,
        "timezone": "Asia/Riyadh"
      },
      "expiry_date": "2029-02-17 17:42:14",
      "order_id": 98787845454,
      "used_at": {},
      "notes": "reason text",
      "reference_id": 3215487
    }
  ],
  "pagination": {
    "count": 30,
    "total": 39,
    "perPage": 30,
    "currentPage": 1,
    "totalPages": 2
  }
}
```

--------------------------------

### Settings Object Example

Source: https://docs.salla.dev/1726815m0

Example of the JSON structure for app configuration values defined in the Partner Portal.

```json
{
  "apiKey": "your-api-key",
  "webhookUrl": "https://api.example.com/webhook",
  "syncEnabled": true
}
```

--------------------------------

### OpenAPI Specification for List Product Variants

Source: https://docs.salla.dev/5394202e0

Defines the GET endpoint for retrieving product variants, including parameters, security requirements, and response examples.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /products/{product}/variants:
    get:
      summary: List Product Variants
      deprecated: false
      description: >-
        This endpoint allows you to list all product variants directly from this
        endpoint by passing the `product` as a path parameter. 


        <Accordion title="Scopes" defaultOpen={true} icon="lucide-key-round">

        `products.read`- Products Read Only

        </Accordion>
      operationId: get-product-variants
      tags:
        - Default module/Merchant API/APIs/Product Variants
        - Product Variants
      parameters:
        - name: product
          in: path
          description: >-
            Unique identification number assigned to a product. List of products
            IDs can be found [here](https://docs.salla.dev/422719m0).
          required: true
          example: 0
          schema:
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/productVariants_response_body'
              example:
                status: 200
                success: true
                data:
                  - id: 652911549
                    price:
                      amount: 13.5
                      currency: SAR
                    sale_price:
                      amount: 0
                      currency: SAR
                    regular_price:
                      amount: 0
                      currency: SAR
                    stock_quantity: 3000
                    barcode: barcode-ABC
                    sku: sku-variant-1551119600
                    related_option_values:
                      - 667315336
                    weight: 3
                    weight_type: kg
                    weight_label: ٣ كجم
                pagination:
                  count: 1
                  total: 1
                  perPage: 60
                  currentPage: 1
                  totalPages: 1
                  links: []
          headers: {}
          x-apidog-name: Success
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_unauthorized_401'
              example:
                status: 401
                success: false
                error:
                  code: Unauthorized
                  message: >-
                    The access token should have access to one of those scopes:
                    products.read_write
          headers: {}
          x-apidog-name: Unauthorized
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object%20Not%20Found(404)'
              example:
                success: false
                status: 404
                error:
                  code: 404
                  message: The content you are trying to access is no longer available
          headers: {}
          x-apidog-name: Not Found
      security:
        - oauth21:
            - offline_access
      x-salla-php-method-name: list
      x-salla-php-return-type: ProductVariant
      x-salla-php-return-base-type: array
      x-apidog-folder: Default module/Merchant API/APIs/Product Variants
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/451700/apis/api-5394202-run
components:
  schemas:
    productVariants_response_body:
      type: object
      properties:
        status:
          type: number
          description: >-
            Response status code, a numeric or alphanumeric identifier used to
            convey the outcome or status of a request, operation, or transaction
            in various systems and applications, typically indicating whether
            the action was successful, encountered an error, or resulted in a
            specific condition.
        success:
          type: boolean
          description: >-
            Response flag, boolean indicator used to signal a particular
            condition or state in the response of a system or application, often
            representing the presence or absence of certain conditions or
            outcomes.
        data:
          type: array
          x-stoplight:
            id: e0sjrcf05t21d
          items:
            $ref: '#/components/schemas/ProductVariant'
        pagination:
          $ref: '#/components/schemas/Pagination'
      x-apidog-orders:
        - status
        - success
        - data
        - pagination
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Pagination:
      type: object
      description: Cursor-based pagination metadata
      properties:
        count:
          type: integer
          examples:
            - 20
```

--------------------------------

### Initialize Twilight JS SDK with Full Settings

Source: https://docs.salla.dev/422610m0

Fetch store settings from the Salla API and pass them to salla.init().

```js
// Fetch store settings using the Salla Store API
async function getStoreSettings() {
  const response = await fetch('https://api.salla.dev/store/v1/store/settings', {
    headers: {
      // Accepts store ID, domain, or username (e.g., salla.sa/username)
      store: 'dev-vgckq3fssfhjewwi'
    }
  });

  return response.json();
}

// Example usage
const storeSettings = await getStoreSettings();
salla.init(storeSettings);
```

--------------------------------

### OpenAPI Specification for List Taxes

Source: https://docs.salla.dev/5394141e0

Defines the GET /taxes endpoint, including pagination parameters, success and error response examples, and security requirements.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /taxes:
    get:
      summary: List Taxes
      deprecated: false
      description: |-
        This endpoint allows you to list all available taxes for your store.

        <Accordion title="Scopes" defaultOpen={true} icon="lucide-key-round">
        `taxes.read`- Taxes Read Only
        </Accordion>
      operationId: List-Taxes
      tags:
        - Default module/Merchant API/APIs/Taxes
        - Taxes
      parameters:
        - name: page
          in: query
          description: The Pagination page number
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/taxes_response_body'
              example:
                status: 200
                success: true
                data:
                  - id: 2087347200
                    tax: 5
                    status: active
                    country: Bahrain
                pagination:
                  count: 1
                  total: 1
                  perPage: 15
                  currentPage: 1
                  totalPages: 1
                  links: []
          headers: {}
          x-apidog-name: Success
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_unauthorized_401'
              example:
                status: 401
                success: false
                error:
                  code: Unauthorized
                  message: >-
                    The access token should have access to one of those scopes:
                    taxes.read
          headers: {}
          x-apidog-name: Unauthorized
      security:
        - oauth21:
            - offline_access
      x-salla-php-method-name: list
      x-salla-php-return-type: Tax
      x-salla-php-return-base-type: array
      x-apidog-folder: Default module/Merchant API/APIs/Taxes
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/451700/apis/api-5394141-run
components:
  schemas:
    taxes_response_body:
      type: object
      properties:
        status:
          type: number
          description: >-
            Response status code, a numeric or alphanumeric identifier used to
            convey the outcome or status of a request, operation, or transaction
            in various systems and applications, typically indicating whether
            the action was successful, encountered an error, or resulted in a
            specific condition.
        success:
          type: boolean
          description: >-
            Response flag, boolean indicator used to signal a particular
            condition or state in the response of a system or application, often
            representing the presence or absence of certain conditions or
            outcomes.
        data:
          type: array
          x-stoplight:
            id: pmmg1k2ottpau
          items:
            $ref: '#/components/schemas/Tax'
        pagination:
          $ref: '#/components/schemas/Pagination'
      x-apidog-orders:
        - status
        - success
        - data
        - pagination
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Pagination:
      type: object
      description: Cursor-based pagination metadata
      properties:
        count:
          type: integer
          examples:
            - 20
        current:
          type: integer
          description: Current page number
          examples:
            - 1
        next:
          type: string
          description: URL for the next page
          examples:
            - https://api.salla.dev/store/v1/orders?page=2
          nullable: true
      x-apidog-orders:
        - count
        - current
        - next
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    Tax:
      description: >-
        Detailed structure of the tax model object showing its fields and data
        types.
      type: object
      x-examples: {}
      x-tags:
        - Models
      title: Tax
      properties:
        id:
          type: number
          description: >-
            A unique identifier number used for tax purposes, often associated
            with individuals or businesses.
        tax:
          type: number
          description: The percentage at which a specific tax is applied to a given amount.
        status:
          type: string
          description: >-
            An individual or entity's position in relation to tax obligations,
            exemptions, and filing requirements.
        country:
          type: string
          description: >-
```
Tokens:
Raw