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.
Building an App on Salla?
The Salla Apps Playbook walks through the full process, planning, building, publishing, and growing an app, end to end.
Base URI
All API URLs referenced in the documentation have the following base: https://api.salla.dev/admin/v2
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.
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 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 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.
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.
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.
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.
List of Salla's Merchant APIs