Salla Docs
Light Mode
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
{
"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
{
"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"
}
}
}
}
Last modified: 21 days ago