Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Merchant API
  • Welcome 👋
  • Get Started
  • Create Your First App
  • Authorization
  • Webhooks
  • Conditional Webhooks
  • Security Considerations
  • Multi-Language Support
  • Responses
  • Pagination
  • Rate Limiting
  • Versioning
  • Change Log
  • Support
  • APIs
    • Orders
      • Create Order
      • List Orders
      • Order Details
      • Create Drafted Order
      • Update Order
      • Duplicate Order
      • Order Actions
    • Order Status
      • Update Order Status
      • Create Custom Order Status
      • List Order Statuses
      • Order Status Details
      • Update Custom Order Status
      • Update Bulk Orders Statuses
      • Sort Orders Statuses
    • Order Histories
      • List Order Histories
      • Create Order History
    • Order Tags
      • Create Order Tag
      • List Order Tags
      • Delete Order Tag
    • Order Invoice
      • Create Invoice
      • List Invoices
      • Invoice Details
      • Send Order Invoice
      • Create Order Invoice
    • Order Reservations
      • List Order Reservations
    • Order Items
      • List Order Items
      • Create Order Item
      • Update Order Item
      • Delete Order Item
    • Products
      • Create Product
      • List Products
      • Product Details
      • Update Product
      • Delete Product
      • Change Product Status
      • Product Details By SKU
      • Update Product By SKU
      • Delete Product By SKU
      • Update Product Price By SKU
      • Update Bulk Product Prices
      • Import Products
      • Bulk Product Actions
    • Product Options
      • Create Product Option
      • Product Option Details
      • Update Product Option
      • Delete Product Option
    • Product Quantity
      • List Product Quantities
      • Update Bulk Quantities
      • List Quantity Change Reasons
      • List Quantity Audit
      • Update Bulk Quantities by SKU
      • Update Quantity
      • Update Quantity By SKU
    • Product Variants
      • List Product Variants
      • Product Variant Details
      • Update Product Variant
      • Update Product Variant Quantity
    • Product Tags
      • Create Product Tag
      • List Product Tags
    • Product Images
      • Attach Image by SKU
      • Attach Video by SKU
      • Attach Youtube Video
      • Attach Image
      • Update Image
      • Delete Image
    • Product Option Values
      • Create Product Option Value
      • Product Option Value Details
      • Update Product Option Value
      • Delete Product Option Value
    • Abandoned Carts
      • List Abandoned Carts
      • Abandoned Cart Details
    • Customer Groups
      • Create Customer Group
      • List Customer Groups
      • Add Customers To Group Customer
      • Update Default Customer Group
      • Update Customer Group
      • Delete Customer Group
    • Customers
      • Create Customer
      • List Customers
      • Customer Details
      • Update Customer
      • Delete Customer
      • Ban Customer
      • Un-Ban customer
      • Import Customers
    • Digitals Product
      • Attach Digital Code
      • Attach Digital File
      • Delete Digital File
    • Categories
      • Create Category
      • List Categories
      • Category Details
      • Update Category
      • Delete Category
      • Category Children
      • Categories Search
      • List Category Products
    • Exports
      • Export Orders
      • Exports Logs
      • List Export Templates
      • Create Export Template
      • Update Export Template
      • Delete Export Template
      • List Export Columns
      • Export Customers
      • Export Custom URLs
      • Export Products
    • Shipments
      • Create Shipment
      • List Shipments
      • Shipment Details
      • Shipment Tracking
      • Update Shipment Details
      • Cancel Shipment
      • Return Shipment
    • Shipping Companies
      • List Shipping Companies
      • Shipping Company Details
      • List Estimate Rates
      • Create Shipping Company
      • Update Shipping Company
      • Delete Shipping Company
      • Shipping Company Options
    • Shipping Zones
      • Create Shipping Zone
      • List Shipping Zones
      • Shipping Zone Details
      • Update Shipping Zone
      • Delete Shipping Zone
    • Shipping Rules
      • List Shipping Rules
      • Shipping Rule Details
      • Delete Shipping Rule
    • Countries
      • List Countries
      • Country Details
    • Product Option Templates
      • List Option Templates
      • Option Template Details
      • Delete Option Template
      • Update Option Template
      • Create Option Template
    • Taxes
      • Create Tax
      • List Taxes
      • Tax Details
      • Update Tax
      • Delete Tax
    • Coupons
      • Create Coupon
      • List Coupons
      • Coupon Details
      • Update Coupon
      • Delete Coupon
      • List Coupon Codes
    • Affiliates
      • List Affiliates
      • Affiliate Details
      • Create Affiliate
      • Update Affiliate
      • Delete Affiliate
    • Order Assignment
      • List Auto Assignment Rules
      • Order Assigned Employees Details
      • Update Auto Assignment Rule
      • Create Auto Assignment Rules
    • Special Offers
      • Create Special Offer
      • List Special Offers
      • Special Offer Details
      • Update Special Offer
      • Delete Special Offer
      • Change Special Offer Status
    • Transactions
      • List Transactions
      • Transaction Details
      • Update Transaction
    • Payments
      • Available Payment Methods
      • List Banks
      • Payment Bank Details
    • Settlements
      • List Instant Settlements
      • Create Instant Settlement
      • Update Instant Settlement
      • Instant Settlement Details
    • Settings
      • Settings List
      • Update Setting Slug
      • Setting Details
    • Merchant
      • User Information Details
      • Store Information
    • Brands
      • Create Brand
      • List Brands
      • Brand Details
      • Update Brand
      • Delete Brand
    • Branches
      • Create Branch
      • List Branches
      • Branch Details
      • Update Branch
      • Delete Branch
    • Currencies
      • Activate Currencies
      • List Currencies
      • List Available Currencies
    • SEO
      • List SEO Settings
      • Update SEO Settings
    • Cities
      • List Cities
    • DNS Records
      • List DNS Records
      • Create DNS Record
      • Delete DNS Record
    • Languages
      • Add Language
      • List Languages
      • Update Language
    • Employees
      • List Employees
    • Advertisements
      • Create Advertisement
      • List Advertisements
      • Advertisement Details
      • Update Advertisement
      • Delete Advertisement
    • Webhooks
      • List Active Webhooks
      • List Events
      • Register Webhook
      • Deactivate Webhook
      • Update Webhook
    • Custom URLs
      • Import Custom URLs
    • Loyalty Points
      • Customer Loyalty Points
      • Update Customer Loyalty Points
    • Reviews
      • List Reviews
      • Review Details
      • Update Review
  • Webhooks - Store Events
    • Order
    • Product
    • Customer
    • Shippings
    • Shipments
    • Brand
    • Invoice
    • Category
    • Store
    • Special Offer
    • Cart
    • Miscellaneous
  1. Merchant API

Get Started

Salla Merchant APIs are a suite of RESTful endpoints, purpose-built for secure, fast, and easy access to Merchant data. Developers can build their Apps by consuming Salla’s standard APIs, scale their Apps to encompass a mass base of over 60,000 online stores, and publish their innovations to one central hub, the Salla App Store. Learn more about creating your first Salla App by following this article.
Base URI
All API URLs referenced in the documentation have the following base: https://api.salla.dev/admin/v2

List of Salla's Merchant APIs#

These endpoints include a suite range of APIs for:
Order Management
Abandoned Carts
Track and manage abandoned shopping carts.
Order Assignments
Assign orders to specific employees or branches.
Order Histories
Track and manage the history of orders.
Order Invoices
Generate and manage order invoices.
Order Items
Manage individual items within an order.
Order Reservations
Handle order reservations and related actions.
Order Statuses
Manage different statuses for orders.
Order Tags
Assign and manage tags for orders.
Orders
Handle order management and details.
Exports
Export data related to products, orders, and other entities.
Product Management
Customer Management
Marketing and Sales
Store Configuration
Shipment Integration
Financial Management
Localization

✅ Requirements#

In order to make developers' interactions with Salla APIs easier, and for a more seamless, professional experience, the bare minimum requirements are as follows:
Basic understanding of programming, API consumption, webhooks calling, and JSON schema.
Authentication & Authorization using the OAuth2.0 security protocol.
Verified Salla Partners account.

💻 APIs Powered By OAuth2.0 With Salla Partners#

Salla Partners, backed by the OAuth2.0 security protocol, allows for scoped access to the Merchants' store. Developers use their account on the Partners Portal to mark the scopes they want to obtain, which is based on their own App’s logic. Those marked app scopes will appear for the Merchant when requesting access, and if access is authorized, the developer can use the access token for a period of 14 days with the ability to refresh it using the refresh token within a 1-month timeline. Read more about the OAuth implementation via these articles here and here.

🔗 Webhooks#

Webhooks are an automated way for a server to talk to another server, allowing application developers to perform actions based on certain events. They provide an efficient and secure means of receiving near-real-time notifications from other services like payment processors, shipping providers and more. Salla provides two sets of events:
App Events: Automatic events sent to your webhook server that are related to your Salla App, which include Store Authorization, App Installed, App Subscription Started, App Settings Updated, and more!
Store Events: Events you can subscribe to from the Partners Portal where only the events you want will be sent to the Webhook Server URL set on the Portal. Such events are explained further below:
Orders
Receive updates on order activities.
Products
Get notifications about product-related events.
Shippings
Be informed of shipping-related changes.
Shipments
Receive alerts for shipment status updates.
Customers
Stay notified about customer activities.
Categories
Get updates for category changes.
Brand
Receive information on brand-related events.
Store
Be notified of store-related occurrences.
Cart
Get alerts on cart activities.
Invoice
Receive updates concerning invoices.
Special Offer
Be informed of special offer events.
Miscellaneous
Get notified about other general updates, such Reviews.
Salla also supports conditional webhooks, where you can write rules specific for a webhook you subscribed to. Read more on how to use such a feature here.

🚫 Rate Limit#

Rate Limit regulates the number of API requests a client/developer can send per second. This helps protect API resources from abuse and overuse, and ensures that the API service is available to all customers who need it. When consuming Salla APIs, and to ensure fairness and stability for all the developers, Rate Limit are set to all the API endpoints.

🌐 Language Support#

Some specific API endpoints have support for multiple languages, which can be achieved via Accept Language and Content Language Header values. Read more on how to utilize the Multi-Language Support feature in Salla APIs in this article.
🕹 Test it out
To get going quickly, we recommend using an API collaboration tool called Postman. You can use the link below to import our collection of endpoints.

Run in Postman

📝 ChangeLog#

Introducing a new endpoint? Updating an existing one? Deprecating or even announcing a breakchange? All is found in the ChangeLog page as well as the API ChangeLog Telegram Channel. The Salla APIs ChangeLog allows users to view new releases, updates, and critical changes to all Salla's APIs. This provides an excellent way for Salla Developers to stay up-to-date with the latest changes that are occurring on Salla.

👥 Community#

Salla Developer Community is a vibrant and active community of developers who discuss topics around Salla Products such as Salla Partners, Salla APIs, Salla Open Source Projects, Twilight, and more. This space is found to connect with developers who are enthusiastic about creating amazing apps and themes as well as providing ultimate, end to end solutions to Salla Merchants. The knowledgbase portal is made for blogs and tutorials that target developers in using Salla Products. Be part of the community and join the Telegram group from here.
Modified at 2025-03-04 12:54:02
Previous
Welcome 👋
Next
Create Your First App