Salla Docs
Light Mode
Webhooks - Store Events
Shippings
Below are the webhook store events paired with their respective data schema related to the Shipping Companies & Shipping Zones webhook events:
Shipping Zone Webhook Events Model
The following includes 2 shipping zone webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "shipping.zone.created",
"merchant": 1305146709,
"created_at": "Thu Apr 14 2022 11:21:47 GMT+0300",
"data": {
"id": 870442223,
"zone_code": ".AE.ajman-city",
"company": {
"id": 488260393,
"slug": null
},
"country": {
"id": 566146469,
"name": "الامارات",
"name_en": "United Arab Emirates",
"code": "AE",
"mobile_code": "+971"
},
"city": {
"id": 374975390,
"name": "مدينة عجمان",
"name_en": "AJMAN CITY"
},
"cities_excluded": [
{
"id": 257742554,
"name": "أبو حليفة",
"name_en": "ABU HALIFA"
},
{
"id": 81998629,
"name": "الأحمدي",
"name_en": "AHMADI"
}
],
"fees": {
"amount": "30",
"currency": "SAR",
"type": "rate",
"weight_unit": "kg",
"up_to_weight": "15",
"amount_per_unit": "2",
"per_unit": "1"
},
"cash_on_delivery": {
"status": true,
"fees": "12"
},
"duration": "3-5"
}
}
Shipping Company Webhook Events Model
The following includes 3 shipping company webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "shipping.company.deleted",
"merchant": 1305146709,
"created_at": "Thu Apr 07 2022 13:48:22 GMT+0300",
"data": {
"id": 488260393,
"name": "شركة سريع",
"status": false
}
}
Brand
Below are the webhook store events paired with their respective data schema related to the Brand webhook events:
Brand Webhook Events Model
The following includes 3 brands webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "brand.created",
"merchant": 596493488,
"created_at": "Sun Mar 24 2024 16:09:48 GMT+0300",
"data": {
"id": 190175156,
"name": "test1212",
"description": "test",
"banner": "https://cdn.salla.sa/image/banner1.png",
"logo": "https://cdn.salla.sa/image/logo1.png",
"status": true,
"ar_char": "ت",
"en_char": "T",
"metadata": {
"title": "1231",
"description": "123",
"url": "123"
}
}
}
Invoice
Below is the webhook store event paired with its respective data schema related to the Invoice webhook events:
Invoice Created Webhook Event Model
This event is triggered when the order status is either completed or restored.
{
"event": "invoice.created",
"merchant": 1601633483,
"created_at": "Mon Feb 20 2023 15:58:00 GMT+0300",
"data": {
"id": 952648521,
"uuid": "a2bffe40-adf7-4bfe-8782-c34ca567ec98",
"invoice_reference_id": "1772",
"order_id": 315606782,
"type": "Credit Note",
"date": "2023-02-20 15:58:00",
"invoice_number": 13,
"payment_method": "bank",
"sub_total": {
"amount": 50,
"currency": "SAR"
},
"shipping_cost": {
"amount": 33,
"taxable": true,
"currency": "SAR"
},
"cod_cost": {
"amount": 0,
"taxable": true,
"currency": "SAR"
},
"discount": {
"amount": 0,
"currency": "SAR"
},
"tax": {
"percent": 50,
"amount": {
"amount": 41.5,
"currency": "SAR"
}
},
"total": {
"amount": 124.5,
"currency": "SAR"
},
"shipping_cost_discount": {
"amount": 0,
"currency": "SAR"
},
"items": [
{
"id": 710619710,
"product_id": "977135276",
"item_id": 409661958,
"name": "User Product Demo",
"quantity": 1,
"type": "product",
"price": {
"amount": 50,
"currency": "SAR"
},
"discount": {
"amount": 0,
"currency": "SAR"
},
"tax": {
"percent": 50,
"amount": {
"amount": 25,
"currency": "SAR"
}
},
"total": {
"amount": 75,
"currency": "SAR"
}
},
{
"name": "رسوم الشحن",
"quantity": 1,
"type": "service",
"price": {
"amount": 33,
"currency": "SAR"
},
"discount": {
"amount": 0,
"currency": "SAR"
},
"tax": {
"percent": 50,
"amount": {
"amount": 16.5,
"currency": "SAR"
}
},
"total": {
"amount": 49.5,
"currency": "SAR"
}
}
],
"customer": {
"id": 166343388,
"first_name": "Username",
"last_name": "Demo",
"mobile": 555555555,
"mobile_code": "+966",
"email": "[email protected]",
"avatar": "https://logo.com/logo.png",
"gender": "female",
"birthday": {
"date": "1997-03-06 00:00:00.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"city": "جدة",
"country": "السعودية",
"country_code": "SA",
"currency": "SAR",
"location": "31.221365",
"updated_at": {
"date": "2023-02-20 15:44:35.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"order_address": {
"description": "Lorem Ipsum",
"street_name": "abu umayyah ad damri",
"additional_number": null,
"building_number": null,
"district": null
}
}
}
}
Miscellaneous
Below are the webhook store events paired with their respective data schema related to the Review Added webhook events:
Review Added Webhook Event Model
This event is triggered when a product's review has been added.
{
"event": "review.added",
"merchant": 1029864349,
"created_at": "Wed Jul 7 2021 14:50:48 GMT+0300",
"data": {
"type": "rating",
"rating": "5",
"content": "Nice",
"customer": {
"id": "2107468057",
"name": "Mohammed Ali",
"mobile": "+28364687236547523745",
"avatar": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
"country": "السعودية",
"city": "الرياض"
},
"product": {
"id": "1653503260",
"type": "codes",
"promotion": {
"title": null,
"sub_title": null
}
},
"status": {
"id": "1298199463",
"name": "تم التنفيذ",
"customized": {
"id": "1693817923",
"name": "تم التنفيذ"
},
"can_cancel": false
},
"is_available": false,
"sku": " ",
"name": "FW180017",
"price": {
"amount": 1600,
"currency": "SAR"
},
"sale_price": {
"amount": "0",
"currency": "SAR"
},
"currency": "SAR",
"url": "https://store.test/nabilanazer/dpXnr",
"thumbnail": null,
"has_special_price": false,
"regular_price": {
"amount": "1600",
"currency": "SAR"
},
"favorite": null,
"order": {
"id": "1289663293",
"reference_id": "27290",
"total": {
"amount": "3732",
"currency": "SAR"
}
},
"date": [
"2022-12-31"
],
"items": [
{
"name": "FW180016",
"quantity": "1"
}
]
}
}
Product
Below are the webhook store events paired with their respective data schema related to the Product webhook events:
Product Webhook Events Model
The following includes 5 product webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "product.created",
"merchant": 1305146709,
"created_at": "Mon Apr 17 2023 12:14:21 GMT+0300",
"data": {
"id": 1025569331,
"promotion": {
"title": null,
"sub_title": null
},
"sku": "",
"mpn": null,
"gtin": null,
"type": "booking",
"name": "Product-Booking-API-Date-and-Time",
"short_link_code": "aezvrRn",
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/product-booking-api-date-and-time/p1025569331",
"admin": "https://s.salla.sa/products/1025569331"
},
"price": {
"amount": 299,
"currency": "SAR"
},
"taxed_price": {
"amount": 343.85,
"currency": "SAR"
},
"pre_tax_price": {
"amount": 299,
"currency": "SAR"
},
"tax": {
"amount": 44.85,
"currency": "SAR"
},
"description": "",
"quantity": 20,
"status": "hidden",
"is_available": false,
"views": 0,
"sale_price": {
"amount": 0,
"currency": "SAR"
},
"sale_end": null,
"require_shipping": false,
"cost_price": null,
"weight": 0,
"weight_type": null,
"with_tax": true,
"url": "https://salla.sa/dev-wofftr4xsra5xtlv/product-booking-api-date-and-time/p1025569331",
"main_image": null,
"images": [],
"sold_quantity": 0,
"rating": {
"total": 0,
"count": 0,
"rate": 0
},
"regular_price": {
"amount": 299,
"currency": "SAR"
},
"max_items_per_user": 1,
"maximum_quantity_per_order": null,
"show_in_app": false,
"notify_quantity": null,
"hide_quantity": true,
"unlimited_quantity": false,
"managed_by_branches": false,
"services_blocks": {
"installments": []
},
"calories": null,
"customized_sku_quantity": false,
"channels": [],
"starting_price": null,
"metadata": {
"title": null,
"description": null
},
"booking_details": {
"id": 231783151,
"type": "date_time",
"session_duration": 50,
"session_gap": 3,
"sessions_count": 10,
"location": "Medina",
"time_strict_type": "days",
"time_strict": 5,
"overrides": [
{
"id": 1476756183,
"date": "2023-04-23"
},
{
"id": 904045008,
"date": "2023-04-24"
}
],
"availabilities": [
{
"day": "sunday",
"is_available": true,
"times": [
{
"from": "09:30",
"to": "13:00"
},
{
"from": "12:00",
"to": "22:00"
}
]
},
{
"day": "monday",
"is_available": true,
"times": [
{
"from": "10:00",
"to": "12:00"
}
]
}
]
},
"allow_attachments": false,
"is_pinned": false,
"pinned_date": "2023-04-17 12:14:20",
"sort": 0,
"enable_upload_image": false,
"updated_at": "2023-04-17 12:14:21",
"options": [],
"skus": [],
"categories": [],
"brand": null,
"tags": []
}
}
Product Channels Changed Webhook Events Model
This event is triggered when a product channel has been changed.
```json
{
'event': 'product.channels.changed',
'merchant': 1328842359,
'created_at': 'Mon Nov 18 2024 13:21:36 GMT+0300',
'data': {
'id': 710434693,
'channels': [
'app',
'Vendors'
]
}
}
```
Customer
Below are the webhook store events paired with their respective data schema related to the Customer webhook events:
Customer Webhook Events Model
The following includes 3 customer webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "customer.login",
"merchant": 1305146709,
"created_at": "Tue Jan 25 2022 12:36:49 GMT+0300",
"data": {
"id": 225167971,
"first_name": "User",
"last_name": "Mohammed",
"mobile": 555555555,
"mobile_code": "+966",
"email": "[email protected]",
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/profile",
"admin": "https://s.salla.sa/customers/l7mYBdgXA9xJwWZRZK8WD42GNkZbjvRO"
},
"avatar": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
"gender": "female",
"birthday": {
"date": "1997-06-03 00:00:00.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"city": "الرياض",
"country": "السعودية",
"country_code": "SA",
"currency": "AED",
"location": "14",
"updated_at": {
"date": "2022-01-24 14:26:55.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
}
}
}
Customers OTP (One-Time Password) Webhook Event Model
This event is triggered when a customer's One-Time Password has been requested.
:::warning[Important Note]This webhook event will only be triggered if both the email and SMS attempts to send the OTP to the customer have failed.:::
{
"event": "customer.otp.request",
"merchant": 1029864349,
"created_at": "Wed Jun 30 2021 12:09:11 GMT+0300",
"data": {
"code": "5331",
"contact": "+96652318526"
}
}
Category
Below are the webhook store events paired with their respective data schema related to the Category webhook events:
Catgeory Webhook Events Model
The following includes 2 category webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "category.created",
"merchant": 1029864349,
"created_at": "Wed Jun 30 2021 14:21:57 GMT+0300",
"data": {
"id": 1429120554,
"name": "test category",
"urls": {
"customer": "https://store.test/nabilanazer/category/neje",
"admin": "/categories"
},
"items": [
"string"
],
"parent_id": 99911771,
"status": "hidden",
"sort_order": "7",
"sub_categories": [
"string"
]
}
}
Store
Below are the webhook store events paired with their respective data schema related to the Store webhook events:
Store Webhook Events Model
The following includes 5 store webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "store.branch.updated",
"merchant": "1029864349",
"created_at": "Wed Jun 30 2021 15:24:18 GMT+0300",
"data": {
"id": "1866839222",
"name": "Riyadh Branch",
"status": "active",
"location": {
"lat": "21.4267",
"lang": "39.8261"
},
"contacts": {
"telephone": "0555555555",
"phone": "+96652318526",
"whatsapp": "+96652318526"
},
"preparation_time": "2",
"is_open": false,
"closest_time": {
"from": "07:00",
"to": "12:00"
},
"working_hours": [
{
"name": "الثلاثاء",
"times": [
{
"from": "07:00",
"to": "12:00"
}
]
}
],
"is_cod_available": true,
"is_default": false,
"type": {},
"cod_cost": "10.00",
"country": {
"id": 1473353380,
"name": "السعودية",
"name_en": "Saudi Arabia",
"code": "SA",
"mobile_code": "+966"
},
"city": {
"id": 1473353380,
"name": "الرياض",
"name_en": "Riyadh",
"country_id": 1473353380
}
}
}
Store Tax Webhook Events Model
This event is triggered when a store tax has been created.
{
"event": "storetax.created",
"merchant": 814202285,
"created_at": "Tue Aug 03 2021 09:35:16 GMT+0300",
"data": {
"id": 5541564,
"tax": "5",
"status": "active",
"country": "All Countries"
}
}
Special Offer
Below are the webhook store events paired with their respective data schema related to the Special Offer webhook events:
Special Offer Webhook Events Model
The following includes 2 special offer webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "specialoffer.updated",
"merchant": 1305146709,
"created_at": "Tue Jan 25 2022 13:26:20 GMT+0300",
"data": {
"id": 1649524234,
"name": "اشتري 1 واحصل على الاخر مجانا",
"message": "اشتري قطعة واحصل على قطعة واحدة مجاناً من التصنيفات التالية",
"expiry_date": null,
"offer_type": "buy_x_get_y",
"status": "inactive",
"buy": {
"type": "category",
"quantity": "1",
"categories": [
{
"id": 1548056,
"name": "البلايز",
"avatar": "sicon-store",
"created_at": "2021-11-01 16:46:06",
"updated_at": "2022-01-16 15:35:55",
"deleted_at": null,
"store_id": 577778,
"parent_id": 0,
"products_counts": 3,
"show_in_menu": 0,
"sort_order": 2,
"status": "active",
"has_hidden_products": 0,
"show_in_app": 1,
"extra_attributes": [],
"custom_url": null
}
]
},
"get": {
"categories": [
{
"id": 256950451,
"name": "البلايز",
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/category/zvawao",
"admin": "https://s.salla.sa/categories"
},
"items": [],
"parent_id": 0,
"status": "active",
"sort_order": 2,
"sub_categories": []
}
],
"type": "category",
"discount_type": "free-product"
}
}
}
Cart
Below are the webhook store events paired with their respective data schema related to the Store webhook events:
Abandoned Cart Webhook Events Model
This event is triggered when an abandoned cart has been created.
{
"event": "abandoned.cart",
"merchant": 1305146709,
"created_at": "Tue Jan 21 2025 18:00:32 GMT+0300",
"data": {
"id": 1097962121,
"total": {
"amount": 100,
"currency": "SAR"
},
"subtotal": {
"amount": 60,
"currency": "SAR"
},
"total_discount": {
"amount": 10,
"currency": "SAR"
},
"checkout_url": "https://salla.sa/dev-wofftr4xsra5xtlv/checkout/1097962121",
"age_in_minutes": 83,
"created_at": {
"date": "2025-01-21 17:09:39.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"updated_at": {
"date": "2025-01-21 17:09:39.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"customer": {
"id": 225167971,
"name": "User Name",
"mobile": "+977612917082",
"email": "[email protected]",
"avatar": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
"country": "السعودية",
"city": "الرياض"
},
"coupon": {
"id": 2036833834,
"code": "wizefriend",
"status": "active",
"type": "percentage",
"amount": 20,
"minimum_amount": 0,
"expiry_date": "2025-04-13 00:00:00",
"start_date": null,
"created_at": "Tue Jan 21 2025 17:00:00 GMT+0300",
"free_shipping": true
},
"items": [
{
"id": 1793843311,
"product_id": 401511871,
"quantity": 2
},
{
"id": 239847784,
"product_id": 64738276,
"quantity": 1
}
]
}
}
```
{
'event':'abandoned.cart.status.changed',
'merchant':1305146709,
'created_at':'Tue Jan 25 2022 13:00:27 GMT+0300',
'data':{
'id':1097962121,
'status':'purchased',
'currency':'SAR',
'subtotal':60,
'total_discount':10,
'totla':100,
'checkout_url':'https://salla.sa/dev-wofftr4xsra5xtlv/checkout/1097962121',
'age_in_minutes':83,
'created_at':'Tue Jan 25 2022 13:00:27 GMT+0300',
'updated_at':'Tue Jan 25 2022 13:00:27 GMT+0300',
'customer':{
'id':225167971,
'name':'User Name',
'mobile':'+977612917082',
'avatar':'https://i.ibb.co/jyqRQfQ/avatar-male.webp',
'country':'السعودية',
'city':'الرياض',
'email':'[email protected]'
},
'coupon':{
'id':2036833834,
'code':'wizefriend',
'status':'active',
'type':'percentage',
'amount':20,
'minimum_amount':0,
'free_shipping':true,
'expiry_date':'2022-04-13 00:00:00',
'created_at':'Tue Jan 25 2022 13:00:27 GMT+0300'
},
'items_count':1,
'items':[
{
'id':1793843311,
'product_id':401511871,
'quantity':2
},
{
'id':239847784,
'product_id':64738276,
'quantity':1
}
],
'cart_history':[
{
'reminder_channel':'sms',
'is_sent':true,
'reminder_date':'Tue Jan 30 2022 13:00:27 GMT+0300',
'created_at':'Tue Jan 25 2022 13:00:27 GMT+0300'
}
]
}
}
```
## Abandoned Cart Purchased Webhook Events Model
This event is triggered when an abandoned cart has been purchased, , where the status is set to `purchased`.
```
{
'event':'abandoned.cart.purchased',
'merchant':1305146709,
'created_at':'Tue Jan 25 2022 13:00:27 GMT+0300',
'data':{
'id':1097962121,
'status':'purchased',
'currency':'SAR',
'subtotal':60,
'total_discount':10,
'totla':100,
'checkout_url':'https://salla.sa/dev-wofftr4xsra5xtlv/checkout/1097962121',
'age_in_minutes':83,
'created_at':'Tue Jan 25 2022 13:00:27 GMT+0300',
'updated_at':'Tue Jan 25 2022 13:00:27 GMT+0300',
'customer':{
'id':225167971,
'name':'User Name',
'mobile':'+977612917082',
'avatar':'https://i.ibb.co/jyqRQfQ/avatar-male.webp',
'country':'السعودية',
'city':'الرياض',
'email':'[email protected]'
},
'coupon':{
'id':2036833834,
'code':'wizefriend',
'status':'active',
'type':'percentage',
'amount':20,
'minimum_amount':0,
'free_shipping':true,
'expiry_date':'2022-04-13 00:00:00',
'created_at':'Tue Jan 25 2022 13:00:27 GMT+0300'
},
'items_count':1,
'items':[
{
'id':1793843311,
'product_id':401511871,
'quantity':2
},
{
'id':239847784,
'product_id':64738276,
'quantity':1
}
],
'cart_history':[
{
'reminder_channel':'sms',
'is_sent':true,
'reminder_date':'Tue Jan 30 2022 13:00:27 GMT+0300',
'created_at':'Tue Jan 25 2022 13:00:27 GMT+0300'
}
]
}
}
```
-->
Coupon Applied Webhook Event Model
This event is triggered when a coupon has been applied.
{
"event": "coupon.applied",
"merchant": 847769313,
"created_at": "Wed Jan 26 2022 22:38:30 GMT+0300",
"data": {
"cart": {
"id": 746780865,
"total": {
"amount": 2910,
"currency": "SAR"
},
"subtotal": {
"amount": 3000,
"currency": "SAR"
},
"total_discount": {
"amount": 100,
"currency": "SAR"
},
"checkout_url": "https://robbama.com/checkout/746780865",
"age_in_minutes": 3517,
"created_at": {
"date": "2022-01-24 12:01:24.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"updated_at": {
"date": "2022-01-26 22:38:30.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"customer": {
"id": 1448307086,
"name": "Nabil Mohammed",
"mobile": "+251944130250",
"avatar": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
"country": "السعودية",
"city": "جدة"
},
"coupon": {
"id": 2036833834,
"code": "wizefriend",
"status": "active",
"type": "percentage",
"amount": {
"amount": 20,
"currency": "SAR"
},
"minimum_amount": {
"amount": 0,
"currency": "SAR"
},
"expiry_date": "2022-04-13 00:00:00",
"created_at": {
"date": "2022-01-24 13:47:47.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
}
},
"items": [
{
"id": 2093591642,
"product_id": 91502809,
"quantity": 2
}
]
}
}
}
Order
Below are the webhook store events paired with their respective data schema related to the Order webhook events:
Orders Webhook Events Model
The following includes 10 order webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
:::danger[Deprecation Notice]The variables, items.codes and items.files, are deprecated. We recommend using instead the data.urls.digital_content variable.:::
{
"event": "order.created",
"merchant": 1305146709,
"created_at": "Sun Jun 26 2022 12:21:48 GMT+0300",
"data": {
"id": 2116149737,
"reference_id": 41027662,
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/order/DXZbOz68qjnYaOw04oBa35wVELBpJyxo",
"admin": "https://s.salla.sa/orders/order/DXZbOz68qjnYaOw04oBa35wVELBpJyxo"
},
"date": {
"date": "2022-06-26 12:21:45.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"draft": false,
"read": true,
"source": "store",
"source_device": "desktop",
"source_details": {
"type": "direct",
"value": null,
"device": "desktop",
"user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
"ip": "31.166.186.78"
},
"status": {
"id": 566146469,
"name": "بإنتظار المراجعة",
"slug": "under_review",
"customized": {
"id": 986688842,
"name": "بإنتظار المراجعة"
}
},
"receipt_image": "https://cdn.salla.sa/jKxK/md4Pv5jeLEX52zWTboKSVr8VmlX5tNbiu9YF00C0.png",
"payment_method": "bank",
"currency": "SAR",
"amounts": {
"sub_total": {
"amount": 186,
"currency": "SAR"
},
"shipping_cost": {
"amount": 15,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": 0,
"currency": "SAR"
},
"tax": {
"percent": "0.00",
"amount": {
"amount": 0,
"currency": "SAR"
}
},
"discounts": [
{
"title": "new offer",
"type": "special",
"code": "new offer",
"discount": "5.00",
"discounted_shipping": 0
}
],
"total": {
"amount": 196,
"currency": "SAR"
}
},
"shipping": {
"id": 1833934431,
"app_id": null,
"company": "السعودية",
"logo": "",
"receiver": {
"name": "Mohammed Ali",
"email": "[email protected]",
"phone": "999123456789"
},
"shipper": {
"name": "Demo",
"company_name": "dev-wofftr4xsra5xtlv",
"email": "[email protected]",
"phone": "966500000000"
},
"pickup_address": {
"country": "السعودية",
"country_code": "SA",
"city": "مكة",
"shipping_address": "شارع عبدالله,السلام,23233, سنابل السلام, مكة,السعودية",
"street_number": "شارع عبدالله",
"block": "السلام",
"postal_code": "23233",
"geo_coordinates": {
"lat": 21.3825905096851,
"lng": 39.77319103068542
}
},
"address": {
"country": "SA",
"country_code": "SA",
"city": "جدة",
"shipping_address": " شارع ابو امية الضمري، الحي الزهراء ،, جدة, السعودية",
"street_number": "ابو امية الضمري",
"block": "الزهراء",
"postal_code": "",
"geo_coordinates": {
"lat": 0,
"lng": 0
}
},
"shipment": {
"id": "0",
"pickup_id": null,
"tracking_link": "0",
"label": []
},
"policy_options": []
},
"shipments": [
{
"id": 649964784,
"created_at": null,
"type": "shipment",
"courier_id": 802226618,
"courier_name": "أوتو",
"courier_logo": "https://salla-dev-portal.s3.eu-central-1.amazonaws.com/uploads/LUZaDEGwzFRDJKO7XVLXtix71Zb8Z2vBt6xwHrwZ.png",
"shipping_number": null,
"tracking_number": null,
"pickup_id": null,
"trackable": false,
"tracking_link": null,
"label": null,
"payment_method": "cod",
"source": "store",
"status": "in_progress",
"total": {
"amount": 175.47,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": 0,
"currency": "SAR"
},
"is_international": true,
"total_weight": {
"value": 0.2,
"units": "kg"
},
"packages": [
{
"item_id": 2077288690,
"external_id": null,
"quantity": 1,
"weight": {
"value": 0.2,
"units": "kg"
}
}
],
"ship_from": {
"type": "branch",
"name": "المستودع الرئيسي التجريبي",
"email": "",
"phone": "966555855555",
"country": "السعودية",
"city": "Medina",
"address_line": "3391 حسين بين عبدلله بين ضميرا,مسجد الدرع,00000, 3391 حسين بين عبدلله بين ضميرا, الدرق موثق, مدينة 42313 8700, سعودي عربية, Medina,السعودية",
"street_number": "3391 حسين بين عبدلله بين ضميرا",
"block": "مسجد الدرع",
"postal_code": "00000",
"latitude": 24.524655575978006,
"longitude": 39.56918120384216,
"branch_id": 1790435930
},
"ship_to": {
"type": "address",
"name": "Test Username",
"email": "[email protected]",
"phone": "971501960991",
"country": "الامارات",
"city": "أبو ظبي",
"address_line": " شارع ijaz street، الحي Shakhbout city 70633،, villa 24,, أبو ظبي, الامارات",
"street_number": "ijaz street",
"block": "Shakhbout city",
"postal_code": "70633",
"latitude": 0,
"longitude": 0
},
"meta": {
"app_id": 846904320,
"policy_options": {
"dimensions": {
"length": "",
"width": "",
"height": ""
}
}
}
}
],
"can_cancel": true,
"show_weight": false,
"can_reorder": true,
"is_pending_payment": false,
"pending_payment_ends_at": 172796,
"total_weight": "٠٫٢٥ كجم",
"rating_link": "https://store-test.com/rating-link",
"shipment_branch": [],
"customer": {
"id": 225167971,
"first_name": "Mohammed",
"last_name": "Ali",
"mobile": 501806978,
"mobile_code": "+966",
"email": "[email protected]",
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/profile",
"admin": "https://s.salla.sa/customers/l7mYBdgXA9xJwWZRZK8WD42GNkZbjvRO"
},
"avatar": "https://cdn.salla.sa/customer_profiles/5i6SUhu9dlF1fvL3EcV98U644eOlG9jcEipz6dOo.jpg",
"gender": "female",
"birthday": {
"date": "1997-06-03 00:00:00.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"city": "جدة",
"country": "السعودية",
"country_code": "SA",
"currency": "SAR",
"location": "",
"updated_at": {
"date": "2022-06-22 10:20:14.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
}
},
"items": [
{
"id": 70815337,
"name": "بيتزا",
"sku": "54534534",
"quantity": 1,
"currency": "SAR",
"weight": 0.25,
"weight_label": "٠٫٢٥ كجم",
"amounts": {
"price_without_tax": {
"amount": 186,
"currency": "SAR"
},
"total_discount": {
"amount": 5,
"currency": "SAR"
},
"tax": {
"percent": "0.00",
"amount": {
"amount": 0,
"currency": "SAR"
}
},
"total": {
"amount": 186,
"currency": "SAR"
}
},
"notes": "",
"product": {
"id": 720881993,
"type": "food",
"promotion": {
"title": "اطلبها ساخنه",
"sub_title": "بيتزا خضار مشكل"
},
"status": "sale",
"is_available": true,
"sku": "54534534",
"name": "بيتزا",
"price": {
"amount": 66,
"currency": "SAR"
},
"sale_price": {
"amount": 45,
"currency": "SAR"
},
"currency": "SAR",
"url": "https://salla.sa/dev-wofftr4xsra5xtlv/بيتزا/p720881993",
"thumbnail": "https://cdn.salla.sa/bYQEn/buItWZf4OLbaTmL7vTMlDUWLOn20hfpq3QUbD2AB.jpg",
"has_special_price": false,
"regular_price": {
"amount": 66,
"currency": "SAR"
},
"calories": "600.00",
"mpn": null,
"gtin": null,
"favorite": null,
"starting_price": null
},
"options": [
{
"id": 1197801866,
"product_option_id": 60176141,
"name": "SIZE",
"type": "checkbox",
"value": [
{
"id": 408420634,
"name": "BIG",
"price": {
"amount": 120,
"currency": "SAR"
}
}
]
},
{
"id": 289546379,
"product_option_id": 1674915438,
"name": "الاضافات",
"type": "checkbox",
"value": [
{
"id": 152115913,
"name": "بصل",
"price": {
"amount": 0,
"currency": "SAR"
}
},
{
"id": 1526610378,
"name": "فلفل",
"price": {
"amount": 0,
"currency": "SAR"
}
}
]
}
],
"images": [],
"codes": [],
"files": []
}
],
"product_reservations": [
{
"id": 1289748598,
"from": "01:10",
"to": "01:40",
"date": "2023-04-18"
}
],
"bank": {
"id": 326553500,
"bank_name": "البنك الأهلي التجاري",
"bank_id": 1473353380,
"account_name": "Demo Account",
"account_number": "000000608010167519",
"iban_number": "SA2380000382608010130308",
"status": "active"
},
"tags": []
},
"pickup_branch": {
"id": 1345871747,
"name": "Branch",
"status": "active",
"location": {
"lat": "37.78044939",
"lng": "-97.8503951"
},
"contacts": {
"phone": "+201099999999",
"whatsapp": "+201099999999",
"telephone": "+201099999999"
},
"preparation_time": "ساعة 30 دقيقة",
"is_open": false,
"closest_time": {
"from": "08:00",
"to": "17:00"
},
"working_hours": [
{
"name": "الأحد",
"times": [
{
"from": "08:00",
"to": "17:00"
},
{
"from": "19:00",
"to": "23:30"
}
]
}
],
"is_cod_available": true,
"is_default": true,
"type": [],
"cod_cost": "15",
"country": {
"id": 1473353380,
"name": "السعودية",
"name_en": "Saudi Arabia",
"code": "SA",
"mobile_code": "+966"
},
"city": {
"id": 1,
"name": "الرياض",
"name_en": "Riyadh"
}
}
}
Order Shipments Webhook Events Model
The following includes 4 order shipment webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "order.shipment.creating",
"merchant": 1305146709,
"created_at": "Sun Jun 26 2022 13:29:51 GMT+0300",
"data": {
"id": 1427738113,
"reference_id": 41030566,
"urls": {
"customer": "https://salla.sa/dev-wofftr4xsra5xtlv/order/AB3exRyLdXv5Wp8KwZ9WrGg4p7Ej8ZKl",
"admin": "https://s.salla.sa/orders/order/AB3exRyLdXv5Wp8KwZ9WrGg4p7Ej8ZKl"
},
"date": {
"date": "2022-06-26 13:29:43.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"source": "dashboard",
"source_device": "desktop",
"source_details": {
"type": "dashboard",
"value": null,
"device": "desktop",
"user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
"ip": null
},
"first_complete_at": null,
"status": {
"id": 566146469,
"name": "بإنتظار المراجعة",
"slug": "under_review",
"customized": {
"id": 986688842,
"name": "بإنتظار المراجعة"
}
},
"payment_method": "bank",
"currency": "SAR",
"amounts": {
"sub_total": {
"amount": 79,
"currency": "SAR"
},
"shipping_cost": {
"amount": 35,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": 0,
"currency": "SAR"
},
"tax": {
"percent": "0.00",
"amount": {
"amount": 0,
"currency": "SAR"
}
},
"discounts": [],
"total": {
"amount": 114,
"currency": "SAR"
}
},
"shipping": {
"id": 1935030040,
"app_id": "2032004508",
"company": "[email protected]",
"logo": "https://salla-dev-portal.s3.eu-central-1.amazonaws.com/uploads/T3GFoIZXP7BsIKMEfdL3XoT9rxSXZN9WpKoFifa8.png",
"receiver": {
"name": "Del Don",
"email": "[email protected]",
"phone": "971555555555"
},
"shipper": {
"name": "Demo",
"company_name": "dev-wofftr4xsra5xtlv",
"email": "[email protected]",
"phone": "966500000000"
},
"pickup_address": {
"country": "السعودية",
"country_code": "SA",
"city": "مكة",
"shipping_address": "شارع عبدالله,السلام,23233, سنابل السلام, مكة,السعودية",
"street_number": "شارع عبدالله",
"block": "السلام",
"postal_code": "23233",
"geo_coordinates": {
"lat": 21.3825905096851,
"lng": 39.77319103068542
}
},
"address": {
"country": "SA",
"country_code": "SA",
"city": "جدة",
"shipping_address": " شارع Abu tamimah، الحي az zahraa 23233،, 5,, جدة, السعودية",
"street_number": "Abu tamimah",
"block": "az zahraa",
"postal_code": "23233",
"geo_coordinates": {
"lat": 0,
"lng": 0
}
},
"shipment": {
"id": "0",
"pickup_id": null,
"tracking_link": "0",
"label": []
},
"policy_options": {
"boxes": "2"
}
},
"can_cancel": true,
"show_weight": false,
"can_reorder": true,
"is_pending_payment": false,
"pending_payment_ends_at": 172791,
"total_weight": "٠٫٢٥ كجم",
"rating_link": "https://store-test.com/rating-link",
"shipment_branch": [
{
"id": 731280709,
"name": "الفرع الرئيسي",
"status": "active",
"is_default": true,
"type": {}
}
],
"customer": {
"id": 1550968832,
"name": "Del Don",
"mobile": "+971555555555",
"email": "[email protected]",
"avatar": "https://store-test.com/cp/assets/images/avatar_male.png",
"country": "الامارات",
"city": ""
},
"items": [
{
"id": 1907902809,
"product_id": 1994210129,
"name": "تنورة",
"sku": "2400409-20000012660-",
"quantity": 1,
"weight": 0.25,
"amounts": {
"price_without_tax": {
"amount": 79,
"currency": "SAR"
},
"total_discount": {
"amount": 0,
"currency": "SAR"
},
"tax": {
"percent": "0.00",
"amount": {
"amount": 0,
"currency": "SAR"
}
},
"total": {
"amount": 79,
"currency": "SAR"
}
}
}
]
}
}
Order Shipment Cancelled Webhook Event Model
The following includes 2 order shipment cancelled webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "order.shipment.cancelled",
"merchant": 1305146709,
"created_at": "Sun Jun 26 2022 14:41:11 GMT+0300",
"data": {
"id": 1427738113,
"reference_id": 41030566,
"shipping_number": "846984645"
}
}
Order Status Updated Webhook Event Model
:::danger[Deprecation Notice]The variables, items.codes and items.files, are deprecated. We recommend using instead the data.urls.digital_content variable.:::
{
"event": "order.status.updated",
"merchant": 193718979,
"created_at": "Wed Aug 17 2022 23:59:38 GMT+0300",
"data": {
"id": 198290473,
"status": "تم التنفيذ",
"customized": null,
"note": "تم إرسال تفاصيل الطلب إلى بريد العميل",
"created_at": {
"date": "2022-08-17 23:59:38.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"order": {
"id": 629263027,
"reference_id": 42264,
"urls": {
"customer": "https://web-f71c00b38eb7308ff0ec2198afc21531.salla.group/test/order/P4GV9LQN3veZl1PV6AWBR6rJ5kzEoxYd",
"admin": "https://dashboard-f71c00b38eb7308ff0ec2198afc21531.salla.group/orders/order/P4GV9LQN3veZl1PV6AWBR6rJ5kzEoxYd"
},
"date": {
"date": "2022-08-17 20:59:36.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"source": "store",
"source_device": "desktop",
"source_details": {
"type": "direct",
"value": null,
"device": "desktop",
"user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.115 Safari/537.36",
"ip": null
},
"first_complete_at": {
"date": "2022-08-17 23:59:36.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"status": {
"id": 1298199463,
"name": "تم التنفيذ",
"slug": "completed"
},
"payment_method": "cod",
"currency": "SAR",
"amounts": {
"sub_total": {
"amount": 246,
"currency": "SAR"
},
"shipping_cost": {
"amount": 33,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": 1,
"currency": "SAR"
},
"tax": {
"percent": "0.00",
"amount": {
"amount": 0,
"currency": "SAR"
}
},
"discounts": [
{
"title": "منتج مجاني: عطر إترنتي مومنت من كالفن كلاين للنساء، او دي بارفان، 100 مل",
"type": "loyalty_prize",
"code": "FREE_PRODUCT",
"discount": "126.00",
"currency": "SAR"
}
],
"total": {
"amount": 154,
"currency": "SAR"
}
},
"shipping": {
"id": 147641223,
"app_id": "618297749",
"company": "محمول",
"logo": "https://cdn.salla.sa/jKxK/y1fgSXdUBbKwKXb6jE3dbmx8zDozt5KuQJ9McXX9.png",
"receiver": {
"name": "User Name",
"email": "[email protected]",
"phone": "96652318526"
},
"shipper": {
"name": "Mohammed Test",
"company_name": "Test",
"email": "[email protected]",
"phone": "96652318526"
},
"pickup_address": {
"country": "السعودية",
"country_code": "SA",
"city": "المدينة المنورة",
"shipping_address": "Macca,Macca,1111, Macca, المدينة المنورة,السعودية",
"street_number": "Macca",
"block": "Macca",
"postal_code": "1111",
"geo_coordinates": {
"lat": 24.45196726,
"lng": 39.587448815
}
},
"address": {
"country": "SA",
"country_code": "SA",
"city": "الرياض",
"shipping_address": " شارع Macca، الحي Macca 1111،, Macca,, الرياض, السعودية",
"street_number": "Macca",
"block": "Macca",
"postal_code": "1111",
"geo_coordinates": {
"lat": 0,
"lng": 0
}
},
"shipment": {
"id": "SALLA000121",
"pickup_id": "SALLA000121001",
"tracking_link": "SALLA000121",
"label": []
},
"policy_options": {
"return_police": "0",
"restore_items": "1",
"refund_loyalty_prize_points": "on",
"send_status_sms": true,
"companyServiceType": "",
"boxes": "1"
}
},
"can_cancel": false,
"show_weight": false,
"can_reorder": false,
"is_pending_payment": false,
"pending_payment_ends_at": 0,
"total_weight": "١ كجم",
"rating_link": "https://store-test.com/rating-link",
"shipment_branch": [
{
"id": 2019138561,
"name": "الرئيسي",
"status": "active",
"is_default": true,
"type": {}
}
],
"customer": {
"id": 1779795066,
"name": "Test Salla",
"mobile": "+96652318526",
"email": "[email protected]",
"avatar": "https://dashboard-f71c00b38eb7308ff0ec2198afc21531.salla.group/cp/assets/images/avatar_male.png",
"country": "السعودية",
"city": "الرياض"
},
"items": [
{
"id": 2105258904,
"product_id": 2047473815,
"name": "سي كيه وان شوك من كالفن كلاين، فور هي، 100 مل",
"sku": "",
"quantity": 1,
"weight": 0.5,
"amounts": {
"price_without_tax": {
"amount": 120,
"currency": "SAR"
},
"total_discount": {
"amount": 0,
"currency": "SAR"
},
"tax": {
"percent": "0.00",
"amount": {
"amount": 0,
"currency": "SAR"
}
},
"total": {
"amount": 120,
"currency": "SAR"
}
}
},
{
"id": 1329648281,
"product_id": 674027926,
"name": "عطر إترنتي مومنت من كالفن كلاين للنساء، او دي بارفان، 100 مل",
"sku": "",
"quantity": 1,
"weight": 0.5,
"amounts": {
"price_without_tax": {
"amount": 126,
"currency": "SAR"
},
"total_discount": {
"amount": 126,
"currency": "SAR"
},
"tax": {
"percent": "0.00",
"amount": {
"amount": 0,
"currency": "SAR"
}
},
"total": {
"amount": 126,
"currency": "SAR"
}
}
}
],
"total": {
"amount": 154,
"currency": "SAR"
}
}
}
}
Shipments
Below are the webhook store events paired with their respective data schema related to the Shipments webhook events:
Shipments Webhook Events Model
The following includes 4 shipments webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab
{
"event": "shipment.creating",
"merchant": 136409261,
"created_at": "Sun Jan 29 2023 21:16:38 GMT+0300",
"data": {
"id": 362985662,
"order_id": 560695738,
"order_reference_id": 48927,
"created_at": {
"date": "2023-01-29 21:16:38.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"type": "shipment",
"courier_id": 1927161457,
"courier_name": "Shipping App",
"courier_logo": "https://company.com/logo.png",
"shipping_number": "846984645",
"tracking_number": "4324233",
"pickup_id": null,
"trackable": true,
"tracking_link": "https://www.company/tracking/tracking-express.html?submit=1&tracking-id=12345",
"label": {
"format": "pdf",
"url": "https://company.com/lable.pdf"
},
"payment_method": "cod",
"source": "api",
"status": "delivered",
"total": {
"amount": 25.5,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": 10.7,
"currency": "SAR"
},
"is_international": false,
"total_weight": {
"value": 5,
"units": "kg"
},
"packages": [
{
"item_id": 2077288690,
"external_id": null,
"name": "منتج تجريبي",
"sku": "6ytrrhrhr",
"price": {
"amount": 25.5,
"currency": "SAR"
},
"quantity": 1,
"weight": {
"value": 5,
"unit": "kg"
}
}
],
"ship_from": {
"type": "branch",
"name": "الفرع الرئيسي",
"email": "",
"phone": "966920034002",
"country": "السعودية",
"city": "Mecca",
"address_line": "Mecca,السعودية",
"street_number": null,
"block": null,
"postal_code": null,
"latitude": 21.3825905096851,
"longitude": 39.77319103068542,
"branch_id": 1987977866
},
"ship_to": {
"type": "address",
"name": "Username",
"email": "[email protected]",
"phone": "966501806978",
"country": "السعودية",
"city": "الرياض",
"address_line": " شارع 2345، الحي السلام 95128،, شارع عبدالله سنابل السلام مكة السعوديه,, الرياض, السعودية",
"street_number": "2345",
"block": "السلام",
"postal_code": "95128",
"latitude": 21.382590509685,
"longitude": 39.773191030685
},
"meta": {
"app_id": 1222362158,
"policy_options": {
"boxes": 1
}
},
"billing_account": "merchant"
}
}