Salla

Salla Products API

The Products API from Salla — 5 operation(s) for products.

GitHub OpenAPI
Business capability
Item Master Data Management BC-2370.10

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /products List or search products · List Products #
Ask an LLM
“Which products are in my Salla store catalog?”
“Can I search products by name or SKU?”
Tell an agent
Find products matching {keyword}.
List products in category {category} with status {status}.
POST /products Add a new product · Create Product #
Ask an LLM
“How do I add a new product to my store?”
“What fields are required to create a product?”
Tell an agent
Create a {product_type} product named {name} priced at {price}.
Add new product {name} at {price}, type {product_type}, with SKU {sku} and {quantity} in stock.
GET /products/{product_id} Get a product's details · Get Product #
Ask an LLM
“What details are stored for a specific product?”
“Can I fetch one product by its ID?”
Tell an agent
Show me product {product_id}.
Get the details of product {product_id}.
PUT /products/{product_id} Update a product · Update Product #
Ask an LLM
“How do I change the price of an existing product?”
“Can I edit an existing product's sale dates or description?”
Tell an agent
Update product {product_id} to name {name}, price {price}, type {product_type}.
Put existing product {product_id} on sale at {sale_price}, keeping name {name}, price {price} and type {product_type}.
DELETE /products/{product_id} Delete a product · Delete Product #
Ask an LLM
“How do I remove a product from my store?”
“Can I permanently delete a product I no longer sell?”
Tell an agent destructive · confirm first
Delete product {product_id}.
Remove product {product_id} from the catalog.
GET /products/{product_id}/skus List a product's SKUs · List Product SKUs #
Ask an LLM
“What variants and SKUs does a product have?”
“Can I see every SKU under one product?”
Tell an agent
List the SKUs of product {product_id}.
Show variants for product {product_id}.
POST /products/options Create a product option · Create Product Option #
Ask an LLM
“How do I add an option like size or color to products?”
“Can I create a new product option?”
Tell an agent
Create a new product option.
Add a size or color option for products.
PUT /products/quantities Bulk update product stock · Update Product Quantities #
Ask an LLM
“How do I update stock levels for several products at once?”
“Can I adjust inventory quantities in bulk?”
Tell an agent
Update stock quantities for my products.
Bulk-adjust product inventory levels.

Documentation

📖
Documentation
https://docs.salla.dev/421117m0
📖
Documentation
https://docs.salla.dev/5394168e0
📖
Documentation
https://docs.salla.dev/5394147e0
📖
Documentation
https://docs.salla.dev/421118m0
📖
Documentation
https://docs.salla.dev/5394234e0
📖
Documentation
https://docs.salla.dev/5394248e0

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/openapi/salla-products-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/json-schema/salla-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/json-schema/salla-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/json-schema/salla-customer-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/json-ld/salla-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/examples/salla-list-products-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/salla/refs/heads/main/examples/salla-create-order-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/salla:salla-products-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

salla-products-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Salla Merchant Products API
  description: 'RESTful endpoints purpose-built for secure, fast, and easy access to Salla

    Merchant store data. Covers products, orders, customers, branches, brands,

    categories, currencies, languages, coupons, taxes, abandoned carts,

    shipping, shipments, and store configuration.


    All requests use the base URL `https://api.salla.dev/admin/v2` and are

    authenticated with an OAuth 2.0 bearer token issued via the Salla Partners

    Portal.'
  version: '2'
  contact:
    name: Salla Developers
    url: https://docs.salla.dev/
    email: support@salla.dev
  license:
    name: Proprietary
    url: https://salla.com/terms
servers:
- url: https://api.salla.dev/admin/v2
  description: Salla Merchant API production
security:
- OAuth2: []
tags:
- name: Products
paths:
  /products:
    get:
      summary: List Products
      operationId: listProducts
      tags:
      - Products
      parameters:
      - name: page
        in: query
        schema:
          type: integer
      - name: per_page
        in: query
        schema:
          type: integer
      - name: keyword
        in: query
        description: Filter products matching a name or SKU value.
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
          enum:
          - hidden
          - sale
          - out
      - name: category
        in: query
        schema:
          type: string
      - name: format
        in: query
        description: Use `light` for simplified product data.
        schema:
          type: string
          enum:
          - light
      responses:
        '200':
          description: Paginated list of products.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductList'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      summary: Create Product
      operationId: createProduct
      tags:
      - Products
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductCreate'
      responses:
        '201':
          description: Product created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
  /products/{product_id}:
    parameters:
    - name: product_id
      in: path
      required: true
      schema:
        type: integer
    get:
      summary: Get Product
      operationId: getProduct
      tags:
      - Products
      responses:
        '200':
          description: Product details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductResponse'
    put:
      summary: Update Product
      operationId: updateProduct
      tags:
      - Products
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductCreate'
      responses:
        '200':
          description: Product updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductResponse'
    delete:
      summary: Delete Product
      operationId: deleteProduct
      tags:
      - Products
      responses:
        '200':
          description: Product deleted.
  /products/{product_id}/skus:
    parameters:
    - name: product_id
      in: path
      required: true
      schema:
        type: integer
    get:
      summary: List Product SKUs
      operationId: listProductSkus
      tags:
      - Products
      responses:
        '200':
          description: List of SKUs for the product.
          content:
            application/json:
              schema:
                type: object
  /products/options:
    post:
      summary: Create Product Option
      operationId: createProductOption
      tags:
      - Products
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Option created.
  /products/quantities:
    put:
      summary: Update Product Quantities
      operationId: updateProductQuantities
      tags:
      - Products
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Quantities updated.
components:
  responses:
    Unauthorized:
      description: Invalid or missing access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    ProductCreate:
      type: object
      required:
      - name
      - price
      - product_type
      properties:
        name:
          type: string
        price:
          type: number
        product_type:
          type: string
          enum:
          - product
          - service
          - group_products
          - codes
          - digital
          - food
          - booking
          - donating
        status:
          type: string
          enum:
          - sale
          - out
          - hidden
          - deleted
        quantity:
          type: integer
        description:
          type: string
        categories:
          type: array
          items:
            type: integer
        sale_price:
          type: number
        cost_price:
          type: number
        sale_start:
          type: string
          format: date-time
        sale_end:
          type: string
          format: date-time
        sku:
          type: string
        mpn:
          type: string
        gtin:
          type: string
        brand_id:
          type: integer
        tags:
          type: array
          items:
            type: string
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image'
        options:
          type: array
          items:
            type: object
        metadata_title:
          type: string
        metadata_description:
          type: string
        metadata_url:
          type: string
    Error:
      type: object
      properties:
        status:
          type: integer
        success:
          type: boolean
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            fields:
              type: object
    ProductList:
      type: object
      properties:
        status:
          type: integer
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/Product'
        pagination:
          $ref: '#/components/schemas/Pagination'
    Pagination:
      type: object
      properties:
        count:
          type: integer
        current:
          type: integer
        next:
          type:
          - string
          - 'null'
    Product:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        sku:
          type: string
        mpn:
          type: string
        gtin:
          type: string
        type:
          type: string
          enum:
          - product
          - service
          - group_products
          - codes
          - digital
          - food
          - booking
          - donating
        status:
          type: string
          enum:
          - sale
          - out
          - hidden
          - deleted
        price:
          $ref: '#/components/schemas/Money'
        sale_price:
          $ref: '#/components/schemas/Money'
        cost_price:
          $ref: '#/components/schemas/Money'
        quantity:
          type: integer
        description:
          type: string
        url:
          type: string
          format: uri
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image'
        categories:
          type: array
          items:
            type: integer
        brand_id:
          type: integer
        tags:
          type: array
          items:
            type: string
        updated_at:
          type: string
          format: date-time
    Money:
      type: object
      properties:
        amount:
          type: number
        currency:
          type: string
          example: SAR
    ProductResponse:
      type: object
      properties:
        status:
          type: integer
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/Product'
    Image:
      type: object
      properties:
        id:
          type: integer
        original:
          type: string
          format: uri
        thumbnail:
          type: string
          format: uri
        alt:
          type: string
        sort:
          type: integer
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.salla.sa/oauth2/auth
          tokenUrl: https://accounts.salla.sa/oauth2/token
          refreshUrl: https://accounts.salla.sa/oauth2/token
          scopes:
            offline_access: Required to receive a refresh token.
            orders.read: Read orders.
            orders.read_write: Read and write orders.
            products.read: Read products.
            products.read_write: Read and write products.
            customers.read: Read customers.
            customers.read_write: Read and write customers.
            settings.read: Read store settings.
            webhooks.read_write: Manage webhook subscriptions.