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

Change Log

In this page, you will find all about Salla APIs' hot fixes, frequent updates, bug fixes, speed imporovement, and deprecated endpoints and requests. We will be displaying both the unreleased and released updates on Salla's API
Alert
Stay updated by visiting this page often and joining the API Changelog Telegram Channel. Notable changes will be documented here for your reference.
Information
We recommend that you use Salla APIs' version of V2. This API, https://api.salla.dev/admin/v2 has no breaking changes so far, and we suggest you use it for production.
Postman Collection
If you are using an API Request Builder, such as Postman, we are regularly updating the Postman Collection whenever there is an update mentioned in ChangeLog page.
🧨 Recent Release is V2.6.8
Run in Postman
The format of this ChangeLog page is based on Keep a Changelog standard.

[2.10.46] - 08-05-2025#

Deprecated#

Effective May 25, 2025, the variables data.checkout_url and data.rating_link will be deprecated and replaced by data.urls.checkout and data.urls.rating, respectively in the following endpoints / webhooks:
Create Order
Update Order
Order Details
Order Webhook Store Events
Order Shipments Webhook Store Events

[2.10.45] - 01-05-2025#

Changed#

The Create Order Item endpoint supports the sku as an enum value in the identifier_type variable.
The Order ID variable is no longer supported in the Update Order Item's body request.

[2.10.44] - 23-04-2025#

Changed#

The List Abandoned Cart endpoint supports the keyword query parameter.
The Available Payment Methods endpoint supports the status query parameter.
The per_page query parameter is now supported on all pagination-enabled endpoints.

[2.10.43] - 14-04-2025#

Changed#

The keyword variable is added as a query parameter in the List Abandoned Carts endpoint.

[2.10.42] - 28-03-2025#

Changed#

New variable, status, added to the Abandoned Cart Details endpoint's response.
Two new webhook store events, abandoned.cart.status.changed and abandoned.cart.purchased.

[2.10.41] - 05-02-2025#

Deprecated#

The variables, items.codes and items.files, are set to deprecated from the following endpoint / webhook responses:
Create Order
Update Order
Duplicate Order
Order Webhook Events:
order.created
order.updated
order.refunded
order.deleted
order.products.updated
order.payment.updated
order.coupon.updated
order.total.price.updated
order.shipping.address.updated
order.cancelled
order.customer.updated
order.status.updated
The variables codes and files are set to be deprecated from the following endpoint responses:
Create Order Item
List Order Items
Update Order Item

Changed#

New variable, digital_content, has been added to the urls object to replace the deprecated variables mentioned above.
Moved the rating_link variable into the urls object.

[2.10.40] - 05-02-2025#

Changed#

The billing_account variable has been added to the following endpoints' responses:
Create Order
Order Details
Update Order
Duplicate Order
Order webhook events:
order.created
order.updated
order.refunded
order.deleted
order.products.updated
order.payment.updated
order.coupon.updated
order.total.price.updated
order.shipping.address.updated
order.cancelled
order.customer.updated
order.shipment.creating
order.shipment.created
order.shipment.return.creating
order.shipment.return.created
order.status.updated
Create Shipment
List Shipments
Shipment Details
Update Shipment Details
Cancel Shipment
Return Shipment
Shipments Webhook events:
shipment.creating
shipment.created
shipment.updated
shipment.cancelled

[2.10.39] - 21-01-2025#

Changed#

The is_apply_with_offer variable has been added to the request bodies for the Create Coupon and Update Coupon endpoints. Additionally, it is included in the response bodies of the following endpoints:
Create Coupon
List Coupons
Coupon Details
Update Coupon

[2.10.38] - 09-01-2025#

Changed#

The variable, external_company_name, has been added to the following endpoints' responses and body requests:
Create Shipment
List Shipments
Shipment Details
Update Shipment Details
Cancel Shipment
Return Shipment

[2.10.37] - 30-12-2024#

Changed#

🛑 Starting from January 20th, 2025, the status variable is required in the Update Shipment Details endpoint's body request. Recommended adapting to this change so as not to face any break change in your production environment.

[2.10.36] - 29-12-2024#

Changed#

The variable, options is added within the package object in the following endpoints:
List Shipments
Shipment Details
Update Shipment Details
Create Shipment
Cancel Shipment
Return Shipment
Shipments Webhook Events Model

[2.10.35] - 18-12-2024#

Added#

Two new endpoints for Customer Loyalty Points, Customer Loyalty Points and Update Customer Loyalty Points.

[2.10.34] - 08-12-2024#

Changed#

The Create Special Offer and Update Special Offer endpoints have a new body request object example, Discount Table Offer Type.

[2.10.33] - 04-12-2024#

Changed#

The Create Special Offer and Update Special Offer endpoints have the variables message and start_date added in the body request.

[2.10.32] - 01-12-2024#

Changed#

The Setting Details has a new object added, channels_status, in the Product Notify Availability response.
The Setting Details has a new response example, Size Guide.
The Export Products has changed the API pathway from /products/export to /exports/products.

[2.10.31] - 28-11-2024#

Added#

Three new endpoints:
Export Customers
Import Custom URLs
Export Custom URLs

Changed#

The Settings List endpoint has a new response example, Marketing Response
The Setting Details has new response examples, Product Inventory & Brand Options Responses

[2.10.30] - 26-11-2024#

Changed#

New variable, subscription_id, added in the response of the following App Events:
app.subscription.started
app.subscription.canceled
app.subscription.expired
app.subscription.renewed

[2.10.29] - 20-11-2024#

Added#

New webhook in Products, product.channels.changed

[2.10.28] - 18-11-2024#

Added#

New endpoint, List Category Products.

Changed#

The following endpoints include the variables image, show_in, update_at, and sub_categories in the response body:
List Categories
Category Details
Create Category
Update Category
The Create Category and Update Category include the image and show_in variables in the request body.

[2.10.27] - 17-11-2024#

Added#

New endpoint, List Trashed Products

Changed#

New body request variable, select_all, added to the Bulk Product Actions

[2.10.26] - 12-11-2024#

Added#

Five new endpoints:
List Option Templates
Option Template Details
Create Option Template
Update Option Template
Delete Option Template

[2.10.25] - 10-11-2024#

Deprecated#

The Update Bulk Quantities By SKU, Update Quantity, and Update Quantity By SKU endpoints are to be deprecated soon. It is recommended to adapt using the Update Bulk Quantities endpoint.

[2.10.24] - 06-11-2024#

Changed#

The Settings List endpoint has the following changes:
The entity variable is used as a query parameter and instead is removed from the path parameter.
Allowed values for entity query parameter includes: products, orders, customers, reports, blogs, mahally and feedbacks.

[2.10.23] - 03-11-2024#

Added#

New endpoint, Products Bulk Editor

[2.10.22] - 30-10-2024#

Changed#

The Update Category endpoint has a new object variable, product, in its body request which allows for assigning products and specifying the sort order.
New query parameter, with, has been added to the Update Category endpoint. When used, it fetches an additional translations object in the response, reflecting the store’s enabled locales.

[2.10.21] - 29-10-2024#

Changed#

New query parameter, keyword, added to the List Branches endpoint

[2.10.20] - 28-10-2024#

Changed#

New body request variable, mode, added to the following endpoints:
Update Quantity
Update Quantity By SKU
Update Bulk Quantities

[2.10.19] - 24-10-2024#

Changed#

The query parameters created_before and created_after have changed to date_from and date_to respectively in the List Customers endpoint

[2.10.18] - 20-10-2024#

Added#

Four new endpoints:
Bulk Product Actions
List Product Quantities
List Quantity Audit
List Quantity Change Reasons

Changed#

Update Bulk Quantities has new body request variables, which are branch and reason_id
Two new query parameters, created_before and created_after, added to the List Customers endpoint

[2.10.17] - 17-10-2024#

Changed#

New query parameter, per_page, added to the List Abanonded Carts endpoint

[2.10.16] - 10-10-2024#

Added#

Two new endpoints, List Deleted Products and Restore Products

[2.10.15] - 09-10-2024#

Added#

Three new endpoints:
Settings List
Setting Details
Update Setting Slug

Changed#

Order Details endpoint support two new objects, actions and features

[2.10.14] - 07-10-2024#

Added#

New endpoint, Category Search

[2.10.13] - 06-10-2024#

Added#

Two new endpoints, Import Products and Export Products

Changed#

New query parameter, with, has been added. When used, it fetches an additional translations object in the response, reflecting the store’s enabled locales for the following endpoints:
List Categories
Category Details
List Brands
Brand Details
New query parameter, format=light, is added to the List Products endpoint. When used, it fetches a mninimal response to the list of products.

[2.10.12] - 02-10-2024#

Changed#

The variable, name, is set as optional where it was previously set to be required in the Create Customer Group endpoint

[2.10.11] - 26-09-2024#

Changed#

Create Customer and Update Customer endpoints have the following body request variables as optional, where they were previously set to be required:
first_name
last_name
mobile

[2.10.10] - 16-09-2024#

Changed#

The webhook event, customer.otp.request, will only be triggered if both the email and SMS attempts to send the OTP to the customer have failed. This behaviour will be official starting from September 24, 2024

[2.10.9] - 15-09-2024#

Deprecated#

All Apps created after 15th of August, 2024 will not be able to use the expanded query parameter in the List Orders endpoint.

[2.10.8] - 08-09-2024#

Changed#

The List Orders endpoint supports the features object in the body response

[2.10.7] - 28-08-2024#

Changed#

The List Shipments endpoint supports the per_page query parameter

[2.10.6] - 08-08-2024#

Changed#

The paths for the endpoints List Transactions, Transaction Details, and Update Transaction have been updated from /payment/transaction to /transaction. Additionally, their scopes have been revised to transactions.read and transactions.read_write.

[2.10.5] - 07-08-2024#

Added#

New endpoint, List Coupon Codes

Changed#

Order Action endpoint has new value object variables

[2.10.4] - 29-07-2024#

Added#

New endpoints added to "Payments", which are:
List Transactions
Transaction Details
Update Transaction

[2.10.3] - 28-07-2024#

Deprecated#

The Order Details endpoint's current response is set to be deprecated soon. The new default response will be what you receive when consuming the Order Details endpoint with the format=light query parameter. As that will be the new response, it is recommended to adapt to this change so as not to face any break change in your production environment.

[2.10.2] - 22-07-2024#

Changed#

The branch_id variable has been added to the body request of the Create Order Item and Update Order Item endpoints
The following endpoints have the shipping_details_id variable added under the shipping object in the body response:
Order Details
Create Order
Duplicate Order
Update Order

Added#

New endpoints added:
Order Assignment
Order Assigned Employees Details
Shipping Companies
List Estimate Rates

[2.10.1] - 14-07-2024#

Changed#

The "exchange_rate" object has been added to the body responses of the following endpoints:
List Orders
Order Details
Create Order
Duplicate Order
Update Order

[2.10.0] - 04-07-2024#

Changed#

The entity variable is used as a query parameter in both List Export Templates and List Export Columns endpoints.

[2.9.9] - 03-07-2024#

Changed#

The base URL for the User Information endpoint will be soon updated from https://api.salla.dev/admin/v2 to https://accounts.salla.sa/. However, the response body remains unchanged. Recommended adapting to this change so as not to face any break change in your production environment.

[2.9.8] - 11-06-2024#

Changed#

List Orders endpoint has new query parameter, created_by

[2.9.7] - 06-06-2024#

Changed#

List Product Variant, Product Variant Details, Update Product Variant, Update Product Variant Quantity endpoints have the updated_at object variable added to its body response

[2.9.6] - 05-06-2024#

Changed#

The List Orders, Order Details, Create Order, and Duplicate Order endpoints' response body have the following changes
Added three new variables:
read
draft
receipt_image
Removed the first_complete_at variable
The Update Order endpoint added the employees array of integers variable in its body request

[2.9.5] - 30-05-2024#

Added#

New endpoint, Order Bulk Actions

[2.9.4] - 06-05-2024#

Changed#

List Invoices endpoint has the following changes:
Added new variables
invoice_number
uuid
invoice_refrence_id
qr_code
payment_method
The item variable is removed
List Orders endpoint no longer includes orders with the draft and deleted statuses
Invoice Details endpoint has new variables, which are:
invoice_number
uuid
invoice_refrence_id
qr_code
payment_method
Order Details, Create Order, Update Order and Update Order Shipment endpoints have the following changes:
Added
updated_at object
is_price_qoute variable
receipt_image variable
reservations and product_reservations variables in customer object
store object
Removed
pick_up_branch object
Query parameter, receiver_details
List Orders endpoint has the following changes
Added
draft variable
read variable
payment_method variable
pending_payment_ends_at variable
thumbnail variable in the items array
customer object

[2.9.3] - 05-05-2024#

Changed#

Category Webhook Events model includes the variable updated_at.
The Category Webhook Events model, Category Details endpoint, Create Category endpoint and Update Category endpoint include the following variables:
metadata-title
metadata-description
metadata-url
List Order Status endpoint variable sort has the data type of number.
List Order Histories endpoint includes the following variables:
avatar in the created_at object.
type variable

Removed#

The variable country_id is not supported in List Cities endpoint.
The variables created_by and type are not supported List Order Histories endpoint.

[2.9.2] - 22-04-2024#

Changed#

The List Orders endpoint includes new query parameters which are sort_by, accounting_services, unread, assign_empolyee, and selling_channel.
The Order Details endpoint, includes a new query parameter, format, which returns Order Details without the following objects; "Shipments", "Items", "Pickup Branch", "Customer Groups", and "Receiver Details".
The List Order Histories endpoint includes the object variable, created_by.

Added#

New endpoints added:
Order
Update Order
Create Drafted Order
Order Invoice
Create Order Invoice
Send Order Invoice
Order Status
Update Bulk Order Statuses
Sort Order Statuses
Order Items
List Order Items
Create Order Items
Update Order Items
Delete Order Item
Order Assignments
List Auto Assignment Rules
Update Auto Assignment Rules
Create Auto Assignment Rules
Order Reservations
List Order Reservations
Exports
Export Orders
List Export Columns
List Export Templates
Create Export Template
Update Export Template
Delete Export Template

[2.9.1] - 2024-04-16#

Added#

We have set rate limitation on all the Customers endpoints, /admin/v2/customers*, to boost the Partners’ performance and streamline interactions with Salla’s servers. Each IP address is individually restricted to not more than 500 requests every 10 minutes for the Customers endpoints. IPs exceeding this limit will face restrictions.

[2.9.0] - 2024-03-31#

Changed#

Major updates occured on the following webhooks' schema:
The country object includes the variable capital in the Store Webhook Events Model
The Special Offer Webhook Events Model includes the following changes:
The buy object variable includes:
type
categories
products
The get object variable includes:
discount_type
type
categories
products
The source object variable is included in the Customer Webhook Events Model
The customer object includes the variable email in the Abandoned Cart Webhook Events Model
The type variable in the Shipping Zone Webhook Events Model includes the following enum values:
fixed
rate
distance
The order object variable in the Order Status Update Events Model has the following objects removed:
bank
product_reservations
tags
The status variable in the Shipments Webhook Events Model has the following changes in its enum values:
pending and returned has been removed
shipped has been added
The following Merchant API endpoints: Create Order, Order Details, Update Order Shipment, and Orders Webhook Event Model:
includes the following variables:
cart_reference_id variable
ship_to object includes:
country_id
city_id
ship_from object includes:
country_id
country_code
city_id
meta object includes the diemnsions object
The Shipments Webhook Event Model includes the following variables:
ship_to object includes:
country_id
city_id
ship_from object includes:
country_id
country_code
city_id
meta object includes the diemnsions object

[2.8.9] - 2024-03-26#

Changed#

The endpoint List Cities include the country_id variable in its body response.
The endpoints List Countries and Country Details include the capital variable in their body responses

[2.8.8] - 2024-03-14#

Changed#

The variables formatted_price, advance, translations, is_out_of_stock, has_special_price, and is_user_suibscribed has been added to the body responses of the following endpoints:
Create Product
List Products
Product Details
Update Product
Product Details by SKU
Update Product by SKU
Update Product Option
Update Product Price by SKU

[2.8.7] - 2024-02-26#

Added#

New endpoint for Update Language

Changed#

The endpoints Add Language and List Languages support sort_order in both body request and response.

[2.8.6] - 2024-02-25#

Changed#

The endpoint List Order Statuses include the variables sort, message, icon, and is_active in its body response.

[2.8.5] - 2024-02-06#

Added#

New body request for the Create Order endpoint. Recommended adapting to this change so as not to face any break change in your production environment.

[2.8.4] - 2024-01-25#

Added#

The endpoint List Active Webhooks now supports the variable pagination.

[2.8.3] - 2024-01-23#

Added#

Two new endpoints for List Banks and Banks Details

Changed#

Updated body requests for both Create Option and Update Product Option endpoints

[2.8.2] - 2024-01-03#

Changed#

The variable type with its enum values ("development", "live", and "demo") has been added to the Store Info Details endpoint

[2.8.1] - 2023-11-05#

Removed#

The variable parent_id is no longer supported in the Update Statuses endpoint
The variables name and message are no longer required in the body request of the Update Statuses endpoint.

[2.8.0] - 2023-11-02#

Added#

Three new endpoints for List Reviews, Review Details, Update Review

[2.7.9] - 2023-09-26#

Changed#

The body response in both List Abandoned Carts and Abandoned Cart Details have new enumerated values support within the coupon.status variable.

[2.7.8] - 2023-09-21#

Changed#

The List Orders Endpoint supports a new query parameter, source which lists the source of the order.
The object variable, features, has been deprecated from the Create Group Endpoint
New endpoint for Abandoned Cart Details

[2.7.7] - 2023-09-03#

Changed#

The variables name and message have multi-language support in the following endpoints:
Create Custom Sub Status
List Order Status
Order Status Detail
Update Status

[2.7.6] - 2023-08-30#

Changed#

The variables name and message have multi-language support in the following endpoints:
List Special Offer
Special Offer Details
Update Special Offer

[2.7.5] - 2023-08-29#

Changed#

The variables metadata.title, metadata.description, and metadata.url have multi-language support in the following endpoints' body responses:
Create Product
List Product
Product Details
Update Product
Product Details by SKU
Update Product by SKU
The variables metadata_title, metadata_description, and metadata_url have multi-language support in the following endpoints' body requests:
Update Product
Update Product by SKU

[2.7.4] - 2023-08-16#

Changed#

The variables item_id and external_id have been added to the following endpoints' / webhooks' response:
Create Order
Order Details
Update Order Shipment
Create Shipment
List Shipments
Update Shipment Details
Shipment Details
Orders Webhook Event Model
Shipments Webhook Event Model

[2.7.3] - 2023-08-15#

Changed#

The Update Product Quantity endpoint's body request has support to the branches_quantities object variable.

[2.7.2] - 2023-08-06#

Changed#

The following App Events includes a new variable, "store_type", which indicates the status of a store being either "development", "demo", or "live":
app.installed
app.uninstalled
app.updated
app.trial.started
app.trial.expired
app.trial.canceled
app.subscription.started
app.subscription.expired
app.subscription.canceled
app.subscription.renewed

[2.7.1] - 2023-08-03#

Added#

New App Event for Cancelling Trial App Subscriptions.

[2.7.0] - 2023-07-31#

Changed#

The variables name, address_description, street, and local have multi-language support in the following endpoints:
List Branches Endpoint
Branch Details Endpoint
Update Branch Endpoint

[2.6.9] - 2023-07-25#

Changed#

The variables metadata.title, metadata.description, and metadata.url have multi-language support in the following endpoints:
List Brands Endpoint
Brand Details Endpoint
Update Brand Endpoint

[2.6.8] - 2023-07-20#

Changed#

The Update Branch Endpoint body request has been enhanced, in which all variables are now marked as Optional.

[2.6.7] - 2023-07-16#

Changed#

Update Variant Endpoint support the cost_price variable in its body request, which replaces the regular_price variable.
Update Variant new variables have beed added gtin, mpn, and notify_low.

[2.6.6] - 2023-07-13#

Changed#

A new value delivering has been added to the variable status of the following models:
Shipments Response
Shipment Response
Shipments Webhook Events

[2.6.5] - 2023-06-19#

Changed#

Create Order Endpoint support the coupon variable in its body request.

[2.6.4] - 2023-06-18#

Changed#

The variables shipment_content_type and packaging_type have been added to the following endpoints:
Create Shipment
List Shipments
Update Shipment Details
Shipment Details
Cancel Shipments
Return Shipments
All Shipments Webhook Event Model

[2.6.3] - 2023-06-07#

Added#

New Endpoint for Update Image

[2.6.2] - 2023-06-06#

Changed#

The variable, groups, has been added to Create Customer, List Customer, Customer Details, Update Customer, as well as the Customer Webhook Events Model.
The variables gender and birthday have been added to the Create Customer and Update Customer.
The object metadata and its variables, title, description and URL, have been added to Create Category, and Update Category endpoints as well as the Category Webhook Event Model.

[2.6.1] - 2023-05-23#

Changed#

The variable subscription_balance has been added to the following endpoint/app events:
App Subscription Details Endpoint
App Subscription Start Event
App Subscription Canceled Event
App Subscription Expire Event
App Subscription Renew Event

[2.6.0] - 2023-05-17#

Changed#

The object metadata and its variables, title, description and URL, have been added to the Create Product, List Products, Product Details, Product Details By SKU, Update Product, Update Product By SKU, and Update Product Price By SKU endpoints as well as Product Webhook Event Model.

[2.5.9] - 2023-05-08#

Changed#

The object metadata and its variables, title, description and URL, have been added to Create Brand, List Brands, Brand Details, and Update Brand endpoints as well as the Brand Webhook Event Model.

[2.5.8] - 2023-05-04#

Changed#

The variable order_reference_id has been added to the following:
Create Shipment
List Shipments
Update Shipment Details
Shipment Details
Cancel Shipments
Return Shipments
All Shipments Webhook Events
New Endpoint for Shipment Tracking.
Update Shipment Details supports the variable status_note in its body request.

[2.5.7] - 2023-04-17#

Changed#

The following Endpoints supports the object variable booking_details, where it is added to:
Create Product
Update Product
Product Details
All Product Webhook events
Order Details and All Order Webhook events supports the object variable product_reservations.

[2.5.6] - 2023-04-11#

Changed#

Create Product, Update Product, and Update Product by SKU endpoints supports the following variables:
channels
show_in_web

[2.5.5] - 2023-03-15#

Changed#

Update Bulk Quantities endpoint supports the unlimited_quantity variable in the Body Request.

[2.5.4] - 2023-03-13#

Added#

New Apps Endpoint for Updating Apps Subscription Balance.

[2.5.3] - 2023-03-12#

Added#

New Endpoint for Creating, Listing, and Deleting DNS Records.

[2.5.2] - 2023-03-09#

Changed#

Order Details supports the shipments array of object, aka Object[Array]
The following Order Webhook Events supports the shipments array of object, aka Object[Array]
order.created
order.updated
order.refunded
order.deleted
order.products.updated
order.payment.updated
order.coupon.updated
order.total.price.updated
order.shipping.address.updated
order.cancelled

[2.5.1] - 2023-03-08#

Changed#

Adding the is_default field as a boolean query parameter to the List Branches endpoint.

[2.5.0] - 2023-02-28#

Changed#

There are new variables added to the List Branches endpoint, which are:
street
address_description
additional_number
building_number
local
postal_code
working_hours
New Endpoint Operation for POSTing Add Note to Order Histories
New Webhook for invoice.created
New Endpoint for Store Info Details

[2.4.9] - 2023-02-06#

Changed#

The App Event app.uninstall includes the field refunded as boolean.

[2.4.8] - 2023-01-15#

Changed#

List Orders supports three new query parameters:
customer_id
coupon
shipping.app_id

[2.4.7] - 2023-01-08#

Changed#

Order Invoice Details supports two identification keys, items[].id & items[].item_id.

[2.4.6] - 2022-12-25#

Changed#

Create Customer Groups and Update Customer Group changed the variable conditions type from object to an array of object, aka Object[Array]

[2.4.5] - 2022-12-09#

Added#

New App Event for Cancelling App Subscriptions.

[2.4.4] - 2022-11-08#

Added#

New Endpoint for Adding Customers to a Customer Group

[2.4.3] - 2022-10-03#

Removed#

The variable pagination is no longer supported in all the catgeories endpoint.

[2.4.2] - 2022-09-26#

Changed#

User Information endpoint returns the following variables in its response:
tax_number
commercial_number

[2.4.1] - 2022-09-14#

Changed#

Attach Image endpoint supports the following variables in its application/json body request:
sort
alt
default

[2.4.0] - 2022-08-23#

Changed#

Update Variant, Show Variant, List Product Variants, Update Product Variant Quantity, and Product Webhook Events have the variables weight, weight_type, and weight_label in its body requests and responses.
Order Details, List Orders, Update Order Shipment, and Order Webhook Events have the variable rating_link in its body response.

[2.3.9] - 2022-07-9#

Changed#

Update Order Status endpoint supports the note variable in its body request.

[2.3.8] - 2022-07-8#

Changed#

Update Bulk Product Prices endpoint supports the following variables:
cost_price
sale_price
sale_end

[2.3.7] - 2022-07-6#

Changed#

Update Order Shipment endpoint supports the cost variable in its body request.

[2.3.6] - 2022-06-8#

Changed#

Order Details, Create Order, and all Order Webhook events endpoints and have support to the source_details object where details about the source of order is appended.
Order Details, and all Order Webhook eventshave the variable slug in its status object.

Deprecated#

The variables source and source_device will be deprecated from all the Order endpoints and webhook events. Instead, use the newly adapted object, source_details.

[2.3.5] - 2022-05-24#

Added#

Multipule Language Support as Header in certain Endpoints, such as the following:
List Products
Product Details
Update Product
List Categories
Category Details
Update Category
List Brands
Brand Details
Update Brand
List Advertisements
Advertisements Details
Update Advertisement
List SEO Settings
Update SEO Settings
Checkout the subsection article regarding the multi-language support.

Changed#

The variables calories, mpn, and gtin have been added to the following Endpoints:
Create Order
List Orders
Order Details
Update Order Shipment
Create Special Offer
List Special Offers
Special Offer Details
Update Special Offer

[2.3.4] - 2022-05-24#

Changed#

App Subscription endpoint has support for the following new variables:
initialization_cost
price_before_discount
coupon
features
App Events, specifically app.subscription.started, app.subscription.expired, and app.subscription.renewed events have support of the coupon variable. Check out the payloads for more.

[2.3.3] - 2022-05-23#

Added#

Introducing New Endpoints/Operations for the following Endpoints:
Create Custom Sub-status
Order Status Details
Update Statuses
In the Update Order Status Endpoint, you can update an order status using either the slug or status_id variables. Check the endpoint for more.

Changed#

The variables calories, mpn, and gtin have been added to the following Endpoints:
Create Product
List Products
Product Details
Update Product
Product Details By SKU
Update Product By SKU
Update Product Price By SKU

[2.3.2] - 2022-05-18#

Changed#

App Events, specifically app.subscription.started, app.subscription.expired, and app.subscription.renewed events have support of the initialization_cost and price_before_discount variables. Check out the payloads for more.

[2.3.1] - 2022-05-10#

Changed#

App Events, specifically app.subscription.started, app.subscription.expired, and app.subscription.renewed events have support of the features array variable. Check out the payloads for more.

[2.3.1] - 2022-04-28#

Added#

New Endpoint for Viewing Details of App Subscriptions.

[2.3.0] - 2022-04-24#

Added#

New Endpoint for Listing, Creating, Viewing Details, Updating, and Deleting Custom Shipping Zones.

Changed#

metadata Object added in the following Endpoints:
List Products
Product Details
Product Details By SKU
Update Product
Update Product By SKU
Update Product Price By SKU
Update Product Option Endpoint has the ability to pass the Product ID when updating a product details' options. Note that old values will be deleted when updating its values with new ones.

[2.2.9] - 2022-04-17#

Added#

New Endpoint for Listing Active Webhooks.
New Set of API Collection in regards to Salla Apps. Checkout the Endpoint for Controlling App Settings.
New Operations Support for Shipping Companies, such as Creating, Updating, and Deleting Shipping Companies.
Support for 5 New Webhook Events in regards to Shipping Companies.

Changed#

Creating Coupon supports creating Group and Marketing Coupns
List SEO Settings have newly supported variables, such as Sitemap URL, Refresh Sitemap and more. Check the endpoint for more details.

Removed#

The variable sub_categories has been removed from the /categories, /categories/{category} and /categories/{category}/children endpoints.

[2.2.8] - 2022-03-24#

Changed#

List Invoices, Invoice Details, and Create Invoice Endpoints have support for the order_id variable.

[2.2.8] - 2022-03-20#

Added#

New Endpoint for Creating Invoices via Third-Party Service Providers.
New Endpoint for Creating, Listing, Viewing Details, Updating, and Deleting Advertisements.
New Endpoint for Updating Bulk Product Prices.
New Operation for Updating SEO Settings.

Changed#

While creating a new product, you are able to add images to the product. Check the endpoint's payload for details.
Listing Shipping Companies and Order Details endpoints contain the app_id variable that identifies the shipping company's Application ID.

[2.2.7] - 2022-02-21#

Changed#

The variable maximum_quantity_per_order has been changed from boolean to integer datatype when Creating a product.

[2.2.7] - 2022-02-13#

Deprecated#

The obtainment of the API Key directly from the Merchant's Dashboard has been deprecated. To acquire an Access Token, follow up the OAuth 2.0 Protocol by exploring this article.

[2.2.7] - 2022-02-02#

Added#

New Endpoint for Creating, Updating, Viewing Details, and Deleting Marketing Affiliates.
New Endpoint to query Available Currencies.

Changed#

All Product endpoints has a variable, namely boolean main, that ensures whether or not the product has an image as a main attribute.

[2.2.6] - 2022-01-25#

Added#

New Endpoints for Attaching Image File and Attaching Video URL to a Product SKU.

[2.2.5] - 2022-01-19#

Added#

New Enpoint for Listing, Viewing Details, and Generating Invoices.
Operation Support for Coupon, as such in Creating, Viewing Details, Updating, and Deleting Coupons.

[2.2.4] - 2022-01-17#

Changed#

There are new updates when Listing Abandoned Carts. Check this endpoint for more.

[2.2.4] - 2022-01-11#

Changed#

List Product Variants (SKUs) and Show Variant (SKU) have a deprecated variable which is related_options. The new value is related_option_values.

[2.2.4] - 2021-12-27#

Added#

Supporting new Endpoints such as:
Listing and Activating/Deactivating for Languages.
Listing and Activating Currencies.
Listing Coupons.
Listing Marketing Affiliates.
Listing Employees.
Listing SEO Settings.
Importing Products from an Excel file.
Importing Customers from an Excel file.
Showing User and Store information.

Changed#

There is a new update on the Product Request, where we support Consisted Products. Check this endpoint for more.
The Order Shipment contains a label object. Check this endpoint for more.

[2.2.3] - 2021-11-21#

Added#

New Endpoint for Listing Shipping Rules as well as Showing, and Deleting Shipping Rule Details.

[2.2.2] - 2021-10-19#

Added#

New Endpoint for Listing and Creating Product Tags.

Changed#

We have updated the payload of Product Details to contain correspondent responses as queried, such as notify_quantity, show_in_app and more variables/responses.

[2.2.2] - 2021-09-21#

Changed#

We have updated the order.shipment.creating and order.shipment.created payload to include customer and items data
Similarly, we have updated the order.shipment.return.creating and order.shipment.return.created payload to include customer and items data

[2.2.2] - 2021-09-13#

Added#

New Endpoint for Cancelling Order Shipments

[2.2.2] - 2021-08-20#

Added#

New Endpoint for Listing Order Shipments

[2.2.2] - 2021-08-03#

Changed#

There are new and updated webhook events that have been added to Webhook

[2.2.2] - 2021-08-02#

Changed#

Rules and Version have been added to Webhook in its Version 2 when registering a webhook

[2.2.2] - 2021-07-26#

Changed#

Coupon Code has been dropped out from the abandoned cart Response
Coupon Details, such as Coupon Items and Checkout URL have been added to the abandoned cart response
Product Response contains with_tax boolean variable, when either fetching a Product Response Updating a product details

[2.2.2] - 2021-06-03#

Added#

** Update Order Shippment Endpoint**
We have added new endpoint that provides support for Merchants and shipment companies who wants to update shippment details.
Endpoint Link

[2.2.1] - 2021-05-25#

Added#

** List Shipping Companies Endpoint**
We have added new endpoint that helps merchants to list all active shipping companies in their store.
Endpoint Link
** Shipment card model added to list orders responses :**
In list orders with expanded = true parameter you will receive Shipment branch details in case of order is being shipped from a branch.

[2.2.0] - 2021-04-14#

Added#

** URLs Applied To Different Modules**
To help companies and merchants, Salla provides a “urls” attribute that has been added to different modules to guide the merchants to have the full URL of this module from both scopes, the dashboard scope as a store admin, and as a customer. Those modules are:
Order Module
Customer Module
Product Module
Category Module
NOTE:
In some modules that extend others, such as order payload which includes an instance of the product details payload, customer details payload, and category details payload, it will return the URLs of each one on its own payload section.

[2.1.0] - 2021-02-22#

Added#

List product variants endpoint
Show variant endpoint
Update variant endpoint
Update variant quantity endpoint
Update bulk quantities by skus endpoint

Changed#

Show Product Option details
Create Product Option
Update Product Option
Add unlimited_quantity to product create, update and responses.

Removed#

Product type from product update request
Quantity from produt option values requests and responses

[2.0.0] - 2021-02-09#

API Version 2.0.0 publish
Added initial commit for API version 2.
Modified at 2025-05-08 13:10:17
Previous
Versioning
Next
Support