Change Log

Shipments Webhook events:

Cancel Shipment

Return Shipment

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:

[2.10.38] - 09-01-2025

Changed

The variable, external_company_name, has been added to the following endpoints' responses and body requests:

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:

Shipments Webhook Events Model

Cancel Shipment

Return Shipment

[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:

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:

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:

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:

[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

Order Invoice

Order Status

Update Bulk Order Statuses

Order Items

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:

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:

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

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:

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: