本文档由 Apifox 自动生成,推荐使用 Apifox - API 文档、API 调试、API Mock、API 自动化测试!
https://api.salla.dev/admin/v2
has no breaking changes so far, and we suggest you use it for production.external_company_name
, has been added to the following endpoints' responses and body requests: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.options
is added within the package
object in the following endpoints:message
and start_date
added in the body request.channels_status
, in the Product Notify Availability response./products/export
to /exports/products
.subscription_id
, added in the response of the following App Events:product.channels.changed
image
, show_in
, update_at
, and sub_categories
in the response body:image
and show_in
variables in the request body.select_all
, added to the Bulk Product Actionsentity
variable is used as a query parameter and instead is removed from the path parameter.entity
query parameter includes: products
, orders
, customers
, reports
, blogs
, mahally
and feedbacks
.product
, in its body request which allows for assigning products and specifying the sort order.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.keyword
, added to the List Branches endpointmode
, added to the following endpoints:created_before
and created_after
have changed to date_from
and date_to
respectively in the List Customers endpointbranch
and reason_id
created_before
and created_after
, added to the List Customers endpointper_page
, added to the List Abanonded Carts endpointactions
and features
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:format=light
, is added to the List Products endpoint. When used, it fetches a mninimal response to the list of products.name
, is set as optional
where it was previously set to be required
in the Create Customer Group endpointoptional
, where they were previously set to be required
:first_name
last_name
mobile
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, 2024expanded
query parameter in the List Orders endpoint.features
object in the body responseper_page
query parameter/payment/transaction
to /transaction
. Additionally, their scopes have been revised to transactions.read
and transactions.read_write
.value
object variables"Payments"
, which are: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.branch_id
variable has been added to the body request of the Create Order Item and Update Order Item endpointsshipping_details_id
variable added under the shipping
object in the body response:"exchange_rate"
object has been added to the body responses of the following endpoints:entity
variable is used as a query parameter in both List Export Templates and List Export Columns endpoints.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.created_by
updated_at
object variable added to its body responseread
draft
receipt_image
first_complete_at
variableemployees
array of integers variable in its body requestinvoice_number
uuid
invoice_refrence_id
qr_code
payment_method
item
variable is removeddraft
and deleted
statusesinvoice_number
uuid
invoice_refrence_id
qr_code
payment_method
updated_at
objectis_price_qoute
variablereceipt_image
variablereservations
and product_reservations
variables in customer
objectstore
objectpick_up_branch
objectreceiver_details
draft
variableread
variablepayment_method
variablepending_payment_ends_at
variablethumbnail
variable in the items
arraycustomer
objectupdated_at
.metadata-title
metadata-description
metadata-url
sort
has the data type of number
.avatar
in the created_at
object.type
variablecountry_id
is not supported in List Cities endpoint.created_by
and type
are not supported List Order Histories endpoint.sort_by
, accounting_services
, unread
, assign_empolyee
, and selling_channel
.format
, which returns Order Details without the following objects; "Shipments"
, "Items"
, "Pickup Branch"
, "Customer Groups"
, and "Receiver Details
".created_by
./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.country
object includes the variable capital
in the Store Webhook Events Modelbuy
object variable includes:type
categories
products
get
object variable includes:discount_type
type
categories
products
source
object variable is included in the Customer Webhook Events Modelcustomer
object includes the variable email
in the Abandoned Cart Webhook Events Modeltype
variable in the Shipping Zone Webhook Events Model includes the following enum values:fixed
rate
distance
order
object variable in the Order Status Update Events Model has the following objects removed:bank
product_reservations
tags
status
variable in the Shipments Webhook Events Model has the following changes in its enum values:pending
and returned
has been removedshipped
has been addedcart_reference_id
variableship_to
object includes:country_id
city_id
ship_from
object includes:country_id
country_code
city_id
meta
object includes the diemnsions
objectship_to
object includes:country_id
city_id
ship_from
object includes:country_id
country_code
city_id
meta
object includes the diemnsions
objectcountry_id
variable in its body response.capital
variable in their body responsesformatted_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:sort_order
in both body request and response.sort
, message
, icon
, and is_active
in its body response.pagination
.type
with its enum values ("development", "live", and "demo"
) has been added to the Store Info Details endpointparent_id
is no longer supported in the Update Statuses endpointname
and message
are no longer required in the body request of the Update Statuses endpoint.coupon.status
variable.source
which lists the source of the order.features
, has been deprecated from the Create Group Endpointname
and message
have multi-language support in the following endpoints:name
and message
have multi-language support in the following endpoints:metadata.title
, metadata.description
, and metadata.url
have multi-language support in the following endpoints' body responses:metadata_title
, metadata_description
, and metadata_url
have multi-language support in the following endpoints' body requests:item_id
and external_id
have been added to the following endpoints' / webhooks' response:branches_quantities
object 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
name
, address_description
, street
, and local
have multi-language support in the following endpoints:metadata.title
, metadata.description
, and metadata.url
have multi-language support in the following endpoints:Optional
.cost_price
variable in its body request, which replaces the regular_price
variable.gtin
, mpn
, and notify_low
.delivering
has been added to the variable status
of the following models:coupon
variable in its body request.shipment_content_type
and packaging_type
have been added to the following endpoints:groups
, has been added to Create Customer, List Customer, Customer Details, Update Customer, as well as the Customer Webhook Events Model.gender
and birthday
have been added to the Create Customer and Update Customer.subscription_balance
has been added to the following endpoint/app events: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.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.order_reference_id
has been added to the following:status_note
in its body request.booking_details
, where it is added to:product_reservations
.channels
show_in_web
unlimited_quantity
variable in the Body Request.shipments
array of object, aka Object[Array]
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
is_default
field as a boolean query parameter to the List Branches endpoint.street
address_description
additional_number
building_number
local
postal_code
working_hours
POST
ing Add Note to Order Historiesinvoice.created
app.uninstall
includes the field refunded
as boolean.customer_id
coupon
shipping.app_id
items[].id
& items[].item_id
.conditions
type from object to an array of object, aka Object[Array]
pagination
is no longer supported in all the catgeories endpoint
.tax_number
commercial_number
application/json
body request:sort
alt
default
weight
, weight_type
, and weight_label
in its body requests and responses.rating_link
in its body response.note
variable in its body request.cost_price
sale_price
sale_end
cost
variable in its body request.source_details
object where details about the source of order is appended.slug
in its status
object.source
and source_device
will be deprecated from all the Order endpoints and webhook events. Instead, use the newly adapted object, source_details
.calories
, mpn
, and gtin
have been added to the following Endpoints:initialization_cost
price_before_discount
coupon
features
app.subscription.started
, app.subscription.expired
, and app.subscription.renewed
events have support of the coupon
variable. Check out the payloads for more.slug
or status_id
variables. Check the endpoint for more.calories
, mpn
, and gtin
have been added to the following Endpoints: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.app.subscription.started
, app.subscription.expired
, and app.subscription.renewed
events have support of the features
array variable. Check out the payloads for more.metadata
Object added in the following Endpoints:5
New Webhook Events in regards to Shipping Companies.Group
and Marketing Coupns
Sitemap URL
, Refresh Sitemap
and more. Check the endpoint for more details.sub_categories
has been removed from the /categories
, /categories/{category}
and /categories/{category}/children
endpoints.order_id
variable.app_id
variable that identifies the shipping company's Application ID.maximum_quantity_per_order
has been changed from boolean
to integer
datatype when Creating a product.main
, that ensures whether or not the product has an image as a main
attribute.new
updates when Listing Abandoned Carts. Check this endpoint for more.related_options
. The new value is related_option_values
.new
update on the Product Request, where we support Consisted Products
. Check this endpoint for more.notify_quantity
, show_in_app
and more variables/responses.new
and updated
webhook events that have been added to Webhookwith_tax
boolean variable, when either fetching a Product Response or Updating a product details